Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.34 KB

Contributing

Eventful supports the Python versions declared in pyproject.toml. Create and activate a virtual environment, then install the complete development toolchain:

python -m pip install -e '.[dev]'

To run only the test suite (including its optional FastAPI, Redis, PostgreSQL, and async test dependencies), install the test requirements instead:

python -m pip install -r requirements-test.txt
python -m pytest tests

In PyCharm, select the project's virtual environment as the interpreter and install requirements-test.txt before using the IDE's pytest runner. Running pytest from an environment containing only the core package is unsupported: the strict pytest configuration deliberately requires pytest-asyncio, and adapter tests import their optional frameworks during collection.

Run the same quality workflow used by every CI Python version:

python scripts/check_quality.py

The workflow runs Ruff, mypy, the test suite with coverage, annotation-policy and public-docstring checks, distribution builds, and the strict documentation build. It stops at the first failure and recreates generated build directories, so reruns do not validate stale artifacts. Every public module, class, function, and method must explain its responsibility or boundary in its docstring.

Public claims must match implemented behavior.