| Name | nox JSON |
| Version |
2025.10.16
JSON |
| download |
| home_page | None |
| Summary | Flexible test automation. |
| upload_time | 2025-10-17 01:53:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
automation
testing
tox
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://github.com/wntrblm/nox/raw/main/docs/_static/alice.png" alt="logo" width=50%>
</p>
# Nox
[](https://github.com/wntrblm/nox)
[](https://github.com/wntrblm/nox)
[](https://pypi.python.org/pypi/nox)
[](https://github.com/wntrblm/nox)
[](https://github.com/wntrblm/nox)
[](https://github.com/wntrblm/nox/actions?query=workflow%3ACI)
[](https://pepy.tech/project/nox)
*Flexible test automation with Python*
* **Documentation:** [https://nox.readthedocs.io](https://nox.readthedocs.io)
* **Source Code:** [https://github.com/wntrblm/nox](https://github.com/wntrblm/nox)
## Overview
`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:
```python
import nox
@nox.session
def tests(session: nox.Session) -> None:
session.install("pytest")
session.run("pytest")
@nox.session
def lint(session: nox.Session) -> None:
session.install("flake8")
session.run("flake8", "--import-order-style", "google")
```
## Installation
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.
To install Nox with [pipx][]:
```shell
pipx install nox
```
You can also use [pip][] in your global python:
```shell
python3 -m pip install nox
```
You may want to user the [user-site][] to avoid messing with your Global python install:
```shell
python3 -m pip install --user nox
```
## Usage
### List all sessions
```shell
nox -l/--list
```
### Run all sessions
```shell
nox
```
### Run a particular session
```shell
nox -s/--session test
```
Checkout the [docs](https://nox.readthedocs.io) for more! 🎉
## Contributing
Nox is an open source project and welcomes contributions of all kinds, checkout the [contributing guide](CONTRIBUTING.md) for help on how to help us out!
All contributors must follow the [code of conduct](CODE_OF_CONDUCT.md) and be nice to one another! 😃
[tox]: https://tox.readthedocs.io
[pipx]: https://pypa.github.io/pipx/
[pip]: https://pip.pypa.io/en/stable/
[user-site]: https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site
Raw data
{
"_id": null,
"home_page": null,
"name": "nox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "automation, testing, tox",
"author": null,
"author_email": "Alethea Katherine Flowers <me@thea.codes>",
"download_url": "https://files.pythonhosted.org/packages/3d/3e/16440c5a2c1e867a862479cf7d11d05d0e0f2bb133de3921cb3ed6e37e57/nox-2025.10.16.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"https://github.com/wntrblm/nox/raw/main/docs/_static/alice.png\" alt=\"logo\" width=50%>\n</p>\n\n# Nox\n\n[](https://github.com/wntrblm/nox)\n[](https://github.com/wntrblm/nox)\n[](https://pypi.python.org/pypi/nox)\n[](https://github.com/wntrblm/nox)\n[](https://github.com/wntrblm/nox)\n[](https://github.com/wntrblm/nox/actions?query=workflow%3ACI)\n[](https://pepy.tech/project/nox)\n\n*Flexible test automation with Python*\n\n* **Documentation:** [https://nox.readthedocs.io](https://nox.readthedocs.io)\n\n* **Source Code:** [https://github.com/wntrblm/nox](https://github.com/wntrblm/nox)\n\n## Overview\n\n`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:\n\n```python\nimport nox\n\n\n@nox.session\ndef tests(session: nox.Session) -> None:\n session.install(\"pytest\")\n session.run(\"pytest\")\n\n@nox.session\ndef lint(session: nox.Session) -> None:\n session.install(\"flake8\")\n session.run(\"flake8\", \"--import-order-style\", \"google\")\n```\n\n## Installation\n\nNox 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.\n\nTo install Nox with [pipx][]:\n\n```shell\npipx install nox\n```\n\nYou can also use [pip][] in your global python:\n\n```shell\npython3 -m pip install nox\n```\n\nYou may want to user the [user-site][] to avoid messing with your Global python install:\n\n```shell\npython3 -m pip install --user nox\n```\n\n## Usage\n\n### List all sessions\n\n```shell\nnox -l/--list\n```\n\n### Run all sessions\n\n```shell\nnox\n```\n\n### Run a particular session\n\n```shell\nnox -s/--session test\n```\n\nCheckout the [docs](https://nox.readthedocs.io) for more! \ud83c\udf89\n\n## Contributing\n\nNox is an open source project and welcomes contributions of all kinds, checkout the [contributing guide](CONTRIBUTING.md) for help on how to help us out!\n\nAll contributors must follow the [code of conduct](CODE_OF_CONDUCT.md) and be nice to one another! \ud83d\ude03\n\n[tox]: https://tox.readthedocs.io\n[pipx]: https://pypa.github.io/pipx/\n[pip]: https://pip.pypa.io/en/stable/\n[user-site]: https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site\n",
"bugtrack_url": null,
"license": null,
"summary": "Flexible test automation.",
"version": "2025.10.16",
"project_urls": {
"bug-tracker": "https://github.com/wntrblm/nox/issues",
"documentation": "https://nox.thea.codes",
"homepage": "https://github.com/wntrblm/nox",
"repository": "https://github.com/wntrblm/nox"
},
"split_keywords": [
"automation",
" testing",
" tox"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6f68f4a9cd43dcd6cf9138e0fb39b3b8f17a82b121e8c26499d864e64c329cd0",
"md5": "87555fdd225c8708691dd3bed9b0f10d",
"sha256": "b4ef28709d5fb0d964ccc987c8863f76ed860700fabd04ad557252df3562a7e5"
},
"downloads": -1,
"filename": "nox-2025.10.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87555fdd225c8708691dd3bed9b0f10d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 74405,
"upload_time": "2025-10-17T01:53:05",
"upload_time_iso_8601": "2025-10-17T01:53:05.792706Z",
"url": "https://files.pythonhosted.org/packages/6f/68/f4a9cd43dcd6cf9138e0fb39b3b8f17a82b121e8c26499d864e64c329cd0/nox-2025.10.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3d3e16440c5a2c1e867a862479cf7d11d05d0e0f2bb133de3921cb3ed6e37e57",
"md5": "d2f99807cc783139ad693f191007ff6d",
"sha256": "fca1e7504384dbc91dddef3fec45d04572f23c882a87241e2c793b77fe1c9259"
},
"downloads": -1,
"filename": "nox-2025.10.16.tar.gz",
"has_sig": false,
"md5_digest": "d2f99807cc783139ad693f191007ff6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4030246,
"upload_time": "2025-10-17T01:53:07",
"upload_time_iso_8601": "2025-10-17T01:53:07.458350Z",
"url": "https://files.pythonhosted.org/packages/3d/3e/16440c5a2c1e867a862479cf7d11d05d0e0f2bb133de3921cb3ed6e37e57/nox-2025.10.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-17 01:53:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wntrblm",
"github_project": "nox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nox"
}
