Skip to content

Installation#

Warning: This library is mainly personal and still in a very early stage. We'll try to follow Semantic Versioning, but breaking changes should be expected. If you are interested in using this library, please make sure to lock the version.

Dependencies#

Currently, apfel requires Python 3.10 or later. Development environment require at least Python 3.11.

apfel depends on the following packages:

Installation#

This library is not published to PyPI. You should install it directly from the GitHub repository. Using pyproject.toml and locking to a Git reference (e.g. a tag) is recommended.

pip#

This is not recommended as you cannot lock the version with pip.

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

uv#

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#

pdm add "apfel @ git+https://github.com/Yixuan-Wang/apfel.git@v{VERSION}"

In pyproject.toml#

[package]
dependencies = [
    "apfel @ git+https://github.com/Yixuan-Wang/apfel.git@v{VERSION}"
]

In pyproject.toml with Poetry#

[tool.poetry.dependencies]
apfel = { git = "https://github.com/Yixuan-Wang/apfel.git", tag = "v{VERSION}" }

In requirements.txt#

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