PyPI install with
pip install file-or-name
To install from the source, clone the github repository and install with pip.
git clone https://github.com/blester125/file-or-name.get
pip install .
If you want to install the package and run tests install the optional testing dependencies. You can use the
option to install in “editable” mode so that changes you make in the source code will get used without re-installing the package.
pip install -e .[test]
Run the tests with
pre-commit hooks to autoformat your changes with black.
pip install pre-commit
Building the Docs
To build the documentation locally install the documentation requirements and run make.
pip install -r requirements-docs.txt