Skip to content

Installation

A-Profiles supports Python 3.11–3.13. Install it into a virtual environment to keep its dependencies separate from system Python and other projects.

Install from PyPI

Create and activate a virtual environment in your project directory:

python -m venv .venv
# macOS / Linux
source .venv/bin/activate
# Windows PowerShell
.venv\Scripts\Activate.ps1

Install the latest release:

python -m pip install --upgrade pip
python -m pip install aprofiles

Use python -m pip to make sure pip is associated with the active Python environment. If you use uv, create and activate a virtual environment first, then run uv pip install aprofiles.

Install the command-line interface

The apro command is available through the optional cli extra:

python -m pip install "aprofiles[cli]"

To install the CLI in its own managed environment, use pipx:

pipx install "aprofiles[cli]"

Install from source

git clone https://github.com/AugustinMortier/A-Profiles.git
cd A-Profiles
python -m venv .venv

Activate .venv using the command for your shell above, then install:

python -m pip install .

For development, install in editable mode with the development, documentation, and CLI dependencies:

python -m pip install -e ".[dev,docs,cli]"