Skip to content
ApfelApfel

Installation

Dependencies

Section titled “Dependencies”

Apfel requires Python 3.11 or later and depends on typing-extensions.

Install from PyPI

Section titled “Install from PyPI”

Apfel is published to PyPI as apfel. Install it with pip, uv, or another modern Python package manager.

Terminal window
pip install apfel
# or
uv add apfel

Install from GitHub

Section titled “Install from GitHub”

Install directly from the GitHub repository when needed. Use pyproject.toml and lock a Git reference, such as a tag, whenever possible.

pip

Section titled “pip”

This is not recommended because pip does not lock the version.

Terminal window
pip install git+https://github.com/Yixuan-Wang/apfel.git@v{VERSION}

uv

Section titled “uv”
Terminal window
uv add git+https://github.com/Yixuan-Wang/apfel.git --tag "v{VERSION}"


# or


uv add git+https://github.com/Yixuan-Wang/apfel.git --ref "{COMMIT_SHA}"

pdm

Section titled “pdm”
Terminal window
pdm add "apfel @ git+https://github.com/Yixuan-Wang/apfel.git@v{VERSION}"

pyproject.toml

Section titled “pyproject.toml”
[project]
dependencies = [
    "apfel @ git+https://github.com/Yixuan-Wang/apfel.git@v{VERSION}"
]

pyproject.toml with Poetry

Section titled “pyproject.toml with Poetry”
[tool.poetry.dependencies]
apfel = { git = "https://github.com/Yixuan-Wang/apfel.git", tag = "v{VERSION}" }

requirements.txt

Section titled “requirements.txt”
apfel @ git+https://github.com/Yixuan-Wang/apfel.git@v{VERSION}