To set up the development environment, clone the repository, install dependencies with Poetry and run tests with PyTest:
poetry install
poetry shell
pytest
To enable linting on each commit, run pre-commit install
. After that, your every commit will be checked with ruff
and mypy
.
The project uses pytest for testing. The tests are organized into separate files for each decorator:
test_df_in.py
: Tests for the df_in decoratortest_df_out.py
: Tests for the df_out decoratortest_df_log.py
: Tests for the df_log decoratortest_decorators.py
: Tests for decorator combinationstest_config.py
: Tests for configuration functionality
Run the tests with:
poetry run pytest
To get a coverage report:
poetry run pytest --cov=daffy
Contributions are welcome! Here are some guidelines:
- Create a feature branch from the main branch
- Add tests for new functionality
- Make sure all tests pass before submitting a PR
- Update documentation as necessary
Please include tests with pull requests to ensure that your changes work as expected.