1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
.. _contributors_guide:
#########################################
Contributors Guide
#########################################
We encourage outside contributors to perform changes on our codebase. Many such changes have been merged already. In order to make it easier to contribute, core developers of this project:
* provide guidance (through the issue reporting system)
* provide tool assisted code review (through the Pull Request system)
* maintain a set of unit tests
* maintain a set of integration tests (run with a production cloud)
* maintain development automation tools using `nox <https://github.com/theacodes/nox>`_ that can easily:
* format the code using `ruff <https://github.com/astral-sh/ruff>`_
* runs linters to find subtle/potential issues with maintainability
* run the test suite on multiple Python versions using `pytest <https://github.com/pytest-dev/pytest>`_
* maintain Continuous Integration (by using GitHub Actions) that:
* runs all sorts of linters
* checks if the Python distribution can be built
* runs all tests on a matrix of 6 versions of Python (including pypy) and 3 operating systems (Linux, Mac OS X and Windows)
* checks if the documentation can be built properly
* maintain other Continuous Integration tools (coverage tracker)
You'll need to have `nox <https://github.com/theacodes/nox>`_ installed:
* ``pip install nox``
With ``nox``, you can run different sessions (default are ``lint`` and ``test``):
* ``format`` -> Format the code.
* ``lint`` -> Run linters.
* ``test`` (``test-3.7``, ``test-3.8``, ``test-3.9``, ``test-3.10``) -> Run test suite.
* ``cover`` -> Perform coverage analysis.
* ``build`` -> Build the distribution.
* ``deploy`` -> Deploy the distribution to the PyPi.
* ``doc`` -> Build the documentation.
* ``doc_cover`` -> Perform coverage analysis for the documentation.
For example::
$ nox -s format
nox > Running session format
nox > Creating virtual environment (virtualenv) using python3.10 in .nox/format
...
$ nox -s format
nox > Running session format
nox > Re-using existing virtual environment at .nox/format.
...
$ nox --no-venv -s format
nox > Running session format
...
Sessions ``test``, ``unit``, and ``integration`` can run on many Python versions, 3.7-3.10 by default.
Sessions other than ``test`` use the last given Python version, 3.10 by default.
You can change it::
export NOX_PYTHONS=3.7,3.8
With the above setting, session ``test`` will run on Python 3.7 and 3.8, and all other sessions on Python 3.8.
Given Python interpreters should be installed in the operating system or via `pyenv <https://github.com/pyenv/pyenv>`_.
Linting
#############
To run all available linters::
$ nox -s lint
Testing
#############
To run all tests on every available Python version::
$ nox -s test
To run all tests on a specific version::
$ nox -s test-3.10
To run just unit tests::
$ nox -s unit-3.10
To run just integration tests::
$ export B2_TEST_APPLICATION_KEY=your_app_key
$ export B2_TEST_APPLICATION_KEY_ID=your_app_key_id
$ nox -s integration-3.10
Documentation
#############
To build the documentation and watch for changes (including the source code)::
$ nox -s doc
To just build the documentation::
$ nox --non-interactive -s doc
|
