Installation¶

This page explains how to install aPrioriDNS in the two most common scenarios:

  1. Regular users who simply want to install the package and run analyses.

  2. Contributors / developers who want to modify the source code, add new features, or participate in the project.

Note

aPrioriDNS supports Python 3.9+ and works on Linux, macOS and Windows. For best reproducibility, it is recommended to install it inside a virtual environment (venv or conda).

Optional: creating a virtual environment¶

Although not required, it is strongly recommended to install aPriori inside a clean environment:

python3 -m venv .venv
source .venv/bin/activate   # on macOS / Linux
.venv\Scripts\activate      # on Windows

pip install aprioridns

conda create -n apriori python=3.11
conda activate apriori
pip install aprioridns

Installing the Development Version (for Contributors)¶

If you plan to:

  • add new features (both for yourself or to contribute to the project)

  • fix bugs,

  • improve documentation and tutorials,

  • contribute DNS datasets or utilities,

then you should install the development version from GitHub.

All the detailed information on how to install the code in editable mode can be found at the How to contribute page.

Upgrading to the latest version¶

To upgrade the PyPI version:

pip install --upgrade aprioridns

To update the development version:

git pull
pip install -e .

You’re ready to go!¶

Once installed, head over to:

  • Quickstart – skip directly here for a first, all-in-one example

  • Tutorials – practical, step by step examples which help developing a deeper understanding of the different features

  • API Guide – complete API reference genrated automatically using Sphinx’s autodoc extension.

Happy exploring!