About zappend

Changelog

You can find the complete zappend changelog here.

Reporting

If you have suggestions, ideas, feature requests, or if you have identified a malfunction or error, then please post an issue.

Contributions

The zappend project welcomes contributions of any form as long as you respect our code of conduct and follow our contribution guide.

If you'd like to submit code or documentation changes, we ask you to provide a pull request (PR) here. For code and configuration changes, your PR must be linked to a corresponding issue.

Development

To set up development environment, with repository root as current working directory:

pip install .[dev,doc]

Testing and Coverage

zappend uses pytest for unit-level testing and code coverage analysis.

pytest --cov=zappend tests

Code Style

zappend source code is formatted using the black tool.

black zappend

Documentation

zappend documentation is built using the mkdocs tool.

With repository root as current working directory:

pip install .[doc]

mkdocs build
mkdocs serve
mkdocs gh-deploy

If the configuration JSON schema in zappend/config/schema.py changes then the configuration reference documentation docs/config.md must be regenerated:

zappend --help-config md > docs/config.md

License

zappend is open source made available under the terms and conditions of the MIT License.