Browse Source

Jazz up the README with some badges/logo etc. (#605)

* Jazz up the README with some badges/logo etc.

* Fix lint changes

* Use consistent project naming in
Tom Fleet 2 months ago committed by GitHub
No known key found for this signature in database
  1. 8
  2. 92
  3. 15
  4. 4


@ -7,7 +7,9 @@ Nox is hosted on [GitHub](
## Support, questions, and feature requests
Feel free to file a bug on [GitHub](
Feel free to file a bug or feature request on [GitHub]( If your question is more general or does not fit neatly into one of those categories, we also have a Nox channel on the Winterbloom Discord server.
You should find a permalink to the invite when you raise a new issue on GitHub.
## Reporting issues
@ -24,7 +26,8 @@ side of including lots of information, such as:
chance to talk it over with the owners and validate your approach.
* Nox maintains 100% test coverage. All pull requests must maintain this.
* Follow [pep8](
* Update documentation, if relevant.
* Update documentation and tests if relevant.
* Ensure your changes pass Nox's tests and lint suites before pushing.
## Running tests
@ -44,7 +47,6 @@ To run against a particular Python version:
nox --session tests-3.8
nox --session tests-3.9
When you send a pull request the CI will handle running everything, but it is
recommended to test as much as possible locally before pushing.


@ -0,0 +1,92 @@
<p align="center">
<img src="docs/_static/alice.png" alt="logo" width=50%>
# Nox
[![Code Style](](
*Flexible test automation with Python*
* **Documentation:** [](
* **Source Code:** [](
## 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:
import nox
def tests(session: nox.Session) -> None:
def lint(session: nox.Session) -> None:
session.install("flake8")"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]:
pipx install nox
You can also use [pip] in your global python:
python3 -m pip install nox
You may want to user the [user-site] to avoid messing with your Global python install:
python3 -m pip install --user nox
## Usage
### List all sessions
nox -l/--list
### Run all sessions
### Run a particular session
nox -s/--session test
Checkout the [docs]( for more! 🎉
## Contributing
Nox is an open source project and welcomes contributions of all kinds, checkout the [contributing guide]( for help on how to help us out!
All contributors must follow the [code of conduct]( and be nice to one another! 😃


@ -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:
.. _Read the Docs:
.. _GitHub:


@ -2,8 +2,8 @@
name = nox
version = 2022.1.7
description = Flexible test automation.
long_description = file: README.rst
long_description_content_type = text/x-rst
long_description = file:
long_description_content_type = text/markdown
url =
author = Alethea Katherine Flowers
author_email =