A file processing pipeline primary designed for static site generation. It is heavily inspired by Metalsmith.

The docs can be found on Read the Docs here: https://pysmith.readthedocs.io/en/latest/.

This library can be installed directly from Github like this:

pip install git+https://github.com/dpk2442/pysmith.git#egg=pysmith

To install any extras use the following command:

pip install git+https://github.com/dpk2442/pysmith.git#egg=pysmith[extra1,extra2]

flake8 is used for linting and Pytest is used for testing. To install the necessary dependencies, first run:

pip install -r requirements_dev.txt

Then use the scripts to run linting:

./scripts/run_flake8.sh
./scripts/run_pytest.sh

If do not want to use the scripts you can use the flake8 and pytest commands directly.

To build the docs locally, first, install the necessary dependencies:

pip install -r requirements_docs.txt

Then navigate to the docs folder and run:

make html

The built docs can be found in the docs/_build/html folder.