AGENTS.md file

Formatting

Always format the code before commiting using, making sure that the Python code is properly formatted using:

pip install black
black .

Run the full test suite:

pip install -r requirements.txt
pip install -r extra.txt
pip install pytest netius
ADAPTER=tiny HTTPBIN=httpbin.bemisc.com pytest

Always update CHANGELOG.md according to semantic versioning, mentioning your changes in the unreleased section.
Write commit messages using Conventional Commits.
Never bump the internal package version in setup.py. This is handled automatically by the release process.
Python files use CRLF as the line ending.
The implementation should be done in Python 2.7+ and compatible with Python 3.12.
The style should respect the black formatting.
The implementation should be done in a way that is compatible with the existing codebase.
Prefer item not in list over not item in list
Prefer item == None over item is None

To create a new release follow the following steps:

Make sure that both the tests pass and the code formatting are valid.
Increment (look at CHANGELOG.md for semver changes) the VERSION value in src/quorum/info.py.
Move all the CHANGELOG.md Unreleased items that have at least one non empty item the into a new section with the new version number and date, and then create new empty sub-sections (Added, Changed and Fixed) for the Unreleased section with a single empty item.
Create a new set of entries in doc/changelog.rst with the same entries and the ones included in the new version in CHANGELOG.md.
Create a commit with the following message version: $VERSION_NUMBER.
Push the commit.
Create a new tag with the value fo the new version number $VERSION_NUMBER.
Create a new release on the GitHub repo using the Markdown from the corresponding version entry in CHANGELOG.md as the description of the release and the version number as the title. Do not include the title of the release (version and date) in the description.

Quorum Extensions for Flask is licensed under the Apache License, Version 2.0.