Contributing to Pynenc¶

Set up your development environment and contribute to Pynenc.

pynenc is a distributed task orchestration library for Python. It solves hard problems in distributed systems — dependency-aware task scheduling, deadlock prevention, concurrency control, and automatic runner recovery — using a clean declarative API.

Contributions are welcome across:

pynenc — core library (this repo)
pynenc.org — project website at github.com/pynenc/pynenc.org
docs — Sphinx documentation, living in the docs/ directory of this repo

Setting Up the Development Environment¶

Fork and Clone:

git clone https://github.com/<your-username>/pynenc.git
cd pynenc

Install UV: Pynenc uses UV for dependency management. Install it following the UV installation guide.
Install Dependencies: Install all dependencies including development and documentation extras:
```
make install
```
Install Pre-commit Hooks: Set up automatic code quality checks:
```
uv run pre-commit install
```
Install Docker (optional): Required for running integration tests with Redis, MongoDB, or RabbitMQ backends. Visit https://docs.docker.com/get-docker/.
Start Development: Make changes, commit, and push to your fork.

Attention

Python docstrings are rendered by MyST and autodoc2. Use Markdown formatting in docstrings. See the MyST syntax cheat sheet and Roles and Directives.

Running Tests¶

Run tests using Makefile targets or UV directly:

Unit tests:
```
make test-unit
```
Integration tests:
```
make test-integration
```
All tests with combined coverage:
```
make test
```

Run tests directly:

uv run pytest pynenc_tests/unit
uv run pytest pynenc_tests/integration

Checking Coverage¶

Generate coverage reports after running tests:

uv run coverage run -m pytest pynenc_tests/
uv run coverage report
uv run coverage html

Open htmlcov/index.html in a browser to view the detailed HTML report.

Maintain or improve test coverage with your contributions. Add tests for new code and bug fixes.

Creating Pull Requests¶

Create a feature branch from main
Make your changes with clear, atomic commits following conventional commit format
Ensure all tests pass: make test
Push to your fork and open a pull request