Installation

Install with uv

Follow the uv installation guide to install uv. From the directory where you want to keep the OpenTAXII virtual environment, run the following commands to install the PyPI release and start the development server.

uv venv --python 3.11
uv pip install opentaxii
uv run --no-project opentaxii-run-dev

uv stores the environment in .venv and downloads Python 3.11 if it needs to. The development server uses SQLite and listens on port 9000. In another terminal, check that the server is responding.

curl --fail http://localhost:9000/management/health

To install the version in a source checkout, run these commands from its root.

uv venv --python 3.11
uv pip install .
uv run --no-project opentaxii-run-dev

For an editable installation and the test suite, see Contributing and developing.

Install Python

OpenTAXII works with Python versions >=3.10. You can download Python here or install it with your operating system’s package manager.

You can verify that Python is installed by typing python or python3 in your shell. You should see something like:

$ python3
Python 3.10.1 (main, Dec 11 2021, 17:22:55) [GCC 11.1.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

Install OpenTAXII

To sandbox the project and protect system-wide python it is recommended to install OpenTAXII into a virtual environment (virtualenv).

Create a virtual environment named venv:

$ virtualenv venv

Where venv is a directory to place the new environment

Activate this environment:

$ . venv/bin/activate
(venv) $

Now install the latest OpenTAXII release from the Python Package Index (PyPI) using pip:

(venv) $ pip install opentaxii

Without the virtual environment it’s just:

$ pip install opentaxii
Note

Since OpenTAXII has libtaxii as a dependency, the system libraries libtaxii will be installed. Check libtaxii documentation for the details.

To install OpenTAXII from source with pip, activate the virtual environment and run this command from the root of the checkout or unpacked source archive.

python -m pip install .

Versioning

OpenTAXII uses major.minor.revision version numbers. The revision number identifies bug-fix releases.

Next steps

Continue to Configuration page to learn how to configure OpenTAXII.