@@ -70,9 +70,14 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
70
70
- To test your changes, run unit tests with ``nox ``::
71
71
72
72
$ nox -s unit-2.7
73
- $ nox -s unit-3.7
73
+ $ nox -s unit-3.8
74
74
$ ...
75
75
76
+ - Args to pytest can be passed through the nox command separated by a `-- `. For
77
+ example, to run a single test::
78
+
79
+ $ nox -s unit-3.8 -- -k <name of test>
80
+
76
81
.. note ::
77
82
78
83
The unit tests and system tests are described in the
@@ -93,8 +98,12 @@ On Debian/Ubuntu::
93
98
************
94
99
Coding Style
95
100
************
101
+ - We use the automatic code formatter ``black ``. You can run it using
102
+ the nox session ``blacken ``. This will eliminate many lint errors. Run via::
103
+
104
+ $ nox -s blacken
96
105
97
- - PEP8 compliance, with exceptions defined in the linter configuration.
106
+ - PEP8 compliance is required , with exceptions defined in the linter configuration.
98
107
If you have ``nox `` installed, you can test that you have not introduced
99
108
any non-compliant code via::
100
109
@@ -133,13 +142,18 @@ Running System Tests
133
142
134
143
- To run system tests, you can execute::
135
144
136
- $ nox -s system-3.7
145
+ # Run all system tests
146
+ $ nox -s system-3.8
137
147
$ nox -s system-2.7
138
148
149
+ # Run a single system test
150
+ $ nox -s system-3.8 -- -k <name of test>
151
+
152
+
139
153
.. note::
140
154
141
155
System tests are only configured to run under Python 2.7 and
142
- Python 3.7 . For expediency, we do not run them in older versions
156
+ Python 3.8 . For expediency, we do not run them in older versions
143
157
of Python 3.
144
158
145
159
This alone will not run the tests. You'll need to change some local
0 commit comments