Skip to content

Contributing

pg_net is OSS. PR and issues are welcome.

Development

Nix is required to set up the environment.

Testing

For testing locally, execute:

1
2
3
4
5
6
7
8
# might take a while in downloading all the dependencies
$ nix-shell

# test on pg 12
$ net-with-pg-12 python -m pytest -vv"

# test on pg 13
$ net-with-pg-13 python -m pytest -vv"

Documentation

All public API must be documented. Building documentation requires python 3.6+

Install Dependencies

Install mkdocs, themes, and extensions.

1
pip install -r docs/requirements_docs.txt

Serving

To serve the documentation locally run

1
mkdocs serve

and visit the docs at http://127.0.0.1:8000/pg_net/