mirror of https://github.com/theacodes/nox.git
Browse Source
* Jazz up the README with some badges/logo etc. * Fix lint changes * Use consistent project naming in CONTRIBUTING.mdpull/614/head
Tom Fleet
2 months ago
committed by
GitHub
4 changed files with 99 additions and 20 deletions
@ -0,0 +1,92 @@
|
||||
<p align="center"> |
||||
<img src="docs/_static/alice.png" alt="logo" width=50%> |
||||
</p> |
||||
|
||||
# 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 |
||||
@ -1,15 +0,0 @@
|
||||
Nox - Flexible test automation for Python |
||||
========================================= |
||||
|
||||
``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. |
||||
|
||||
The latest documentation is available on `Read the Docs`_. |
||||
|
||||
The source code is available on `GitHub`_. |
||||
|
||||
|
||||
.. _tox: https://tox.readthedocs.io |
||||
.. _Read the Docs: https://nox.readthedocs.io |
||||
.. _GitHub: https://github.com/wntrblm/nox |
||||
Loading…
Reference in new issue