Contributing and developing

Reporting issues

OpenTAXII uses Github’s issue tracker. See the OpenTAXII project page on Github.

Obtaining the source code

The OpenTAXII source code can be found on Github. See the OpenTAXII project page.

Layout

OpenTAXII repository has the following layout:

  • docker/ - Docker configuration files (OpenTAXII Docker documentation);
  • docs/ - used to build the documentation;
  • examples/ - configuration and code examples;
  • opentaxii/ - OpenTAXII source;
  • tests/ - opentaxii tests.

Database schema

image

Set up a development environment

Install uv as described in the installation guide. From the repository root, create a virtual environment and install an editable copy of OpenTAXII with its development dependencies.

uv venv --python 3.11
uv pip install -r requirements-dev.txt -e .

OpenTAXII’s package metadata lives in setup.py. Use uv run --no-project to run commands in .venv with the installed package.

Running the tests

Run the test suite from the repository root. It uses temporary SQLite databases by default.

uv run --no-project python -m pytest

The CI matrix in tox.ini also tests against MySQL, MariaDB, and PostgreSQL.

Generating the documentation

The documentation is written in Quarto Markdown and built with Quarto. From the repository root, install the documentation dependencies and render the book.

uv pip install -r docs/requirements.txt
uv run --no-project python docs/render-references.py
quarto render docs

Quarto writes the HTML, PDF, and EPUB to docs/_book/. Run quarto preview docs for a local preview.

GitHub Actions builds the book for pull requests and publishes it to GitHub Pages from master.

Next steps

Continue to License.