Contributing¶

Prerequisites¶

Note

The package development requires rsync executable in the system environment.

Install package:

pip install -e .[development]

Note

Use the -e, --editable flag to install the package in development mode.

Note

Set up a virtual environment for development.

Sort imports:

isort setup.py nfsops/ docs/ tests/

Format source code:

autopep8 --recursive --in-place setup.py nfsops/ docs/ tests/

Check static typing:

mypy setup.py nfsops/ docs/ tests/

Lint source code:

pylint setup.py nfsops/ docs/ tests/

Test package:

pytest

Report test coverage:

pytest --cov nfsops/

Build documentation:

cd docs/
sphinx-build -b html nfsops/ build/

Note

This step will generate the API reference before building.

Hint

See also the Makefile for development.

Overview

API Reference