From b1457d8826b619e836c0a349574397f7a982adf9 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 20 Feb 2024 16:50:16 -0500 Subject: [PATCH] docs: update some links Signed-off-by: Henry Schreiner --- README.md | 8 ++++---- docs/index.rst | 22 ++++++++++++++++------ 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d75b0bf5..536fc0ba 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ## 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: +`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 @@ -41,19 +41,19 @@ def lint(session: nox.Session) -> None: 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]: +To install Nox with [pipx][]: ```shell pipx install nox ``` -You can also use [pip] in your global python: +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: +You may want to user the [user-site][] to avoid messing with your Global python install: ```shell python3 -m pip install --user nox diff --git a/docs/index.rst b/docs/index.rst index 59b145f1..910f086a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,9 +14,13 @@ Welcome to Nox ``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. -Install nox via `pip`_:: +To install Nox with `pipx`_:: - pip install --user --upgrade nox + pipx install nox + +You can also use `pip`_ in your global python:: + + python3 -m pip install nox 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 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`. .. _tox: https://tox.readthedocs.org -.. _pip: https://pip.readthedocs.org +.. _pip: https://pip.pypa.io +.. _pipx: https://pipx.pypa.io .. _pytest: http://pytest.org -.. _virtualenv: https://virtualenv.readthedocs.org +.. _virtualenv: https://virtualenv.pypa.io Projects that use Nox --------------------- -Nox is lucky to have several wonderful projects that use it and provide feedback and contributions. +Nox is lucky to have `over 3,000 `__ wonderful projects that use it and provide feedback and contributions. A few of them are: - `Bézier `__ - `cibuildwheel `__ @@ -59,6 +64,7 @@ Nox is lucky to have several wonderful projects that use it and provide feedback - `google-cloud-python `__ - `google-resumable-media-python `__ - `Hydra `__ +- `Jupyter `__ - `manylinux `__ - `OmegaConf `__ - `OpenCensus Python `__ @@ -66,9 +72,11 @@ Nox is lucky to have several wonderful projects that use it and provide feedback - `packaging.python.org `__ - `pip `__ - `pipx `__ +- `pybind11 `__ - `Salt `__ - `Scikit-build `__ -- `Scikit-HEP `__ +- `Scikit-HEP `__ +- `Scientific Python `__ - `Subpar `__ - `Urllib3 `__ - `Zazo `__ @@ -80,6 +88,7 @@ Nox is not the only tool of its kind. If Nox doesn't quite fit your needs or you - `tox `__ is the de-facto standard for managing multiple Python test environments, and is the direct spiritual ancestor to Nox. - `Invoke `__ 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. +- `Hatch `__ A modern, extensible Python project manager using ``pyproject.toml`` configuration and a scripts + environments approach. Maintainers & contributors @@ -93,6 +102,7 @@ Our maintainers are (in alphabetical order): * `Claudio Jolowicz `__ * `Danny Hermes `__ * `Diego Ramirez `__ +* `Henry Schreiner `__ * `Luke Sneeringer `__ * `Santos Gallegos `__ * `Thea Flowers `__