Metadata-Version: 2.4
Name: vutils-nox
Version: 0.0.1
Summary: Shared Nox configuration for vutils
Author-email: Jiří Kučera <sanczes@gmail.com>
License-Expression: MIT
Project-URL: Home Page, https://github.com/i386x/vutils-nox
Project-URL: Issues, https://github.com/i386x/vutils-nox/issues
Project-URL: Source, https://github.com/i386x/vutils-nox
Keywords: nox
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nox
Requires-Dist: mypy
Requires-Dist: packaging
Requires-Dist: pkginfo
Requires-Dist: pydantic
Requires-Dist: pyproject-metadata
Requires-Dist: setuptools
Requires-Dist: tomli-w
Provides-Extra: flake8-dummy
Requires-Dist: vutils-testing; extra == "flake8-dummy"
Provides-Extra: mypy-extra
Requires-Dist: types-setuptools; extra == "mypy-extra"
Dynamic: license-file

[![Coverage Status](https://coveralls.io/repos/github/i386x/vutils-nox/badge.svg?branch=main)](https://coveralls.io/github/i386x/vutils-nox?branch=main)

# vutils-nox: Shared Nox Configuration for Vutils

`vutils-nox` is an extension of [Nox](https://nox.thea.codes/en/stable/) that
contains a shared project and linters configurations and workflows, mostly
intended to be used by `vutils-*` packages.

## Installation

`vutils-nox` can be installed via `pip`:

```console
$ pip install vutils-nox
```

For other options, see the next section.

## Usage

To start using `vutils-nox` workflows, just add to your `noxfile.py`:

```python
from vutils.nox.nox import setup

setup()
```

Importing `vutils.nox.nox` will populate Nox sessions registry with the
predefined sessions, `setup()` ensures that Nox will run these sessions
correctly and efficiently.

With the Nox feature to [load dependencies from `pyproject.toml` or scripts](https://nox.thea.codes/en/stable/tutorial.html#loading-dependencies-from-pyproject-toml-or-scripts)
you do not even have `vutils-nox` installed. Just make sure your `noxfile.py`
contains

```python
# /// script
# dependencies = ["nox", "vutils-nox"]
# ///

from vutils.nox.nox import setup

setup()
```

and Nox will install `vutils-nox` for you to its own dedicated environment.
