Skip to content

best-practice-and-impact/assumptions

Repository files navigation

assumptions

PyPI release Actions build status Documentation Status

See the assumptions package documentation for detailed usage and customisation.

Installation and Usage

The Python package can be installed from PyPI:

pip install assumptions

Run the command line tool to generate help documentation:

assumptions -h

By default, assumptions will recursively search the current directory for assumptions and caveats, before writing the log to the same directory.

We recommend including assumptions in pre-commit configurations:

repos:
-   repo: https://github.com/foster999/assumptions
    rev: 1.1.0
    hooks:
    -   id: assumptions

This ensures that up-to-date logs are included in your project's version control.

Alternatively, the command line tool can be called as part of continuous integration workflows.