You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@
20
20
21
21
## Overview
22
22
23
-
`nox` is a command-line tool that automates testing in multiple Python environments, similar to [tox]. Unlike tox, Nox uses a standard Python file for configuration:
23
+
`nox` is a command-line tool that automates testing in multiple Python environments, similar to [tox][]. Unlike tox, Nox uses a standard Python file for configuration:
Nox is designed to be installed globally (not in a project virtual environment), the recommended way of doing this is via [pipx], a tool designed to install python CLI programs whilst keeping them separate from your global or system python.
43
43
44
-
To install Nox with [pipx]:
44
+
To install Nox with [pipx][]:
45
45
46
46
```shell
47
47
pipx install nox
48
48
```
49
49
50
-
You can also use [pip] in your global python:
50
+
You can also use [pip][] in your global python:
51
51
52
52
```shell
53
53
python3 -m pip install nox
54
54
```
55
55
56
-
You may want to user the [user-site] to avoid messing with your Global python install:
56
+
You may want to user the [user-site][] to avoid messing with your Global python install:
Copy file name to clipboardexpand all lines: docs/index.rst
+16-6
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,13 @@ Welcome to Nox
14
14
15
15
``nox`` is a command-line tool that automates testing in multiple Python environments, similar to `tox`_. Unlike tox, Nox uses a standard Python file for configuration.
16
16
17
-
Install nox via `pip`_::
17
+
To install Nox with `pipx`_::
18
18
19
-
pip install --user --upgrade nox
19
+
pipx install nox
20
+
21
+
You can also use `pip`_ in your global python::
22
+
23
+
python3 -m pip install nox
20
24
21
25
22
26
Nox is configured via a ``noxfile.py`` file in your project's directory. Here's a simple noxfile that runs lint and some tests::
@@ -42,14 +46,15 @@ For each session, Nox will automatically create a `virtualenv`_ with the appropr
42
46
To learn how to install and use Nox, see the :doc:`tutorial`. For documentation on configuring sessions, see :doc:`config`. For documentation on running ``nox``, see :doc:`usage`.
Nox is lucky to have several wonderful projects that use it and provide feedback and contributions.
57
+
Nox is lucky to have `over 3,000 <https://github.com/search?type=code&q=path%3Anoxfile.py+NOT+is%3Afork>`__ wonderful projects that use it and provide feedback and contributions. A few of them are:
@@ -80,6 +88,7 @@ Nox is not the only tool of its kind. If Nox doesn't quite fit your needs or you
80
88
81
89
- `tox <https://tox.readthedocs.org>`__ is the de-facto standard for managing multiple Python test environments, and is the direct spiritual ancestor to Nox.
82
90
- `Invoke <https://www.pyinvoke.org/>`__ is a general-purpose task execution library, similar to Make. Nox can be thought of as if Invoke were tailored specifically to Python testing, so Invoke is a great choice for scripts that need to encompass far more than Nox's specialization.
91
+
- `Hatch <https://hatch.pypa.io>`__ A modern, extensible Python project manager using ``pyproject.toml`` configuration and a scripts + environments approach.
83
92
84
93
85
94
Maintainers & contributors
@@ -93,6 +102,7 @@ Our maintainers are (in alphabetical order):
0 commit comments