Getting Started#
Installing requirements#
Poetry Installation and Setup#
imap-processing uses Poetry for dependency management. Check out our style guide for more information on specific IMAP Poetry usage.
If you’re running locally, you can install the Python requirements with Poetry.
To setup versioning (recommended for developers)
poetry self add poetry-dynamic-versioning
To install without the extras
poetry install
To install all extras
poetry install --all-extras
This will install the dependencies from poetry.lock, ensuring that consistent versions are used. Poetry also provides a virtual environment, which you will have to activate.
poetry shell
In summary, the expected setup of Poetry for a development environment is:
poetry self add poetry-dynamic-versioning
poetry install --all-extras
Using IMAP processing#
The main way to run IMAP processing locally is through the CLI.
Our tests are run using pytest:
poetry shell
pytest