APKBUILD examples:Python: Difference between revisions

Latest revision as of 21:55, 7 April 2026

Typical Python packages use Python-specific build systems, making their build() and package() functions different compared to an application which uses make.

Considerations

pkgname

Package name for a Python library must be prefixed with py3-.

For an 'executable' (for example, black, binwalk), you generally don't need to prefix it.

arch

noarch: Use for pure Python packages (i.e. without compiled code).
all (and others): Use for packages with native extensions (i.e. with compiled code).

depends

Do not add python3 to depends= (it's auto-detected via dynamic linking to python library).

source

Most Python packages are published in PyPI(the Python Package Index). If the package has a source tarball available in PyPI (that’s true for most packages), and it contains tests (some explicitly remove them from PyPI), you should reference it in source= as:

https://files.pythonhosted.org/packages/source/${_pyname%${_pyname#?}}/$_pyname/$_pyname-$pkgver.tar.gz

where _pyname is the real name of the Python package.

Otherwise, use the normal upstream git tarballs.

Examples

pep517 invocation

pkgname="py3-foo"
_pyname=foo
...
depends="py3-bar py3-baz"
makedepends="py3-gpep517 py3-setuptools py3-wheel python3-dev"
checkdepends="py3-pytest"
subpackages="$pkgname-pyc"
source="$pkgname-$pkgver.tar.gz::https://github.com/xyz/foo/archive/refs/tags/v$pkgver.tar.gz"
builddir="$srcdir/$_pyname-$pkgver"
...

build() {
	gpep517 build-wheel --wheel-dir .dist --output-fd 3 3>&1
}

check() {
	python3 -m venv --clear --system-site-packages testenv
	testenv/bin/python3 -m installer .dist/*.whl
	testenv/bin/python3 -m pytest
}

package() {
	python3 -m installer -d "$pkgdir" \
		dist/*.whl
}

Depending on the build-backend in the pyproject.toml, the package should depend on py3-setuptools, py3-flit-core, py3-poetry-core or py3-hatchling at build time. If a project specifies literally flit or poetry, patch it to use the -core variant.

@@ Line 1: / Line 1: @@
-A lot of Python packages use the ''setuptools'' or ''distutils'' framework. This mean that the build() and the package() section looks a bit different compared to an application which uses ''make''.
+Typical Python packages use Python-specific build systems, making their <code>build()</code> and <code>package()</code> functions different compared to an application which uses ''make''.
+== Considerations ==
+=== pkgname ===
+Package name for a Python ''library'' must be prefixed with ''py3-''.
+For an 'executable' (for example, <code>black</code>, <code>binwalk</code>), you generally don't need to prefix it.
+=== arch ===
+; noarch : Use for pure Python packages (i.e. without compiled code).
+; all (and others) :  Use for packages with native extensions (i.e. with compiled code).
+=== depends ===
+'''Do not''' add python3 to <tt>depends=</tt> (it's auto-detected via dynamic linking to python library).
+=== source ===
+Most Python packages are published in [https://pypi.python.org/pypi PyPI](the Python Package Index).
+If the package has a source tarball available in PyPI (that’s true for most packages), and it contains tests (some explicitly remove them from PyPI), you should reference it in <tt>source=</tt> as:
 <pre>
-pkgname="py3-foo"
+https://files.pythonhosted.org/packages/source/${_pyname%${_pyname#?}}/$_pyname/$_pyname-$pkgver.tar.gz
-...
+</pre>
-depends="python3"
-makedepends="python3-dev"
+where <tt>_pyname</tt> is the real name of the Python package.
-...
-build() {
+Otherwise, use the normal upstream git tarballs.
-	cd "$builddir"
-	python3 setup.py build
-}
-package() {
+== Examples ==
-	cd "$builddir"
-	python3 setup.py install --prefix=/usr --root="$pkgdir"
-}
-</pre>
-If Python package support both Python 2 and Python 3, then the Alpine package should provide both variants as ''py2-'' and ''py3-'' subpackages.
+=== pep517 invocation ===
 <pre>
-pkgname="py-foo"
+pkgname="py3-foo"
-_pkgname="Foo"
+_pyname=foo
 ...
-depends=""
+depends="py3-bar py3-baz"
-makedepends="python2-dev python3-dev"
+makedepends="py3-gpep517 py3-setuptools py3-wheel python3-dev"
-subpackages="py2-${pkgname#py-}:_py2 py3-${pkgname#py-}:_py3"
+checkdepends="py3-pytest"
+subpackages="$pkgname-pyc"
+source="$pkgname-$pkgver.tar.gz::https://github.com/xyz/foo/archive/refs/tags/v$pkgver.tar.gz"
+builddir="$srcdir/$_pyname-$pkgver"
 ...
 build() {
-	cd "$builddir"
+	gpep517 build-wheel --wheel-dir .dist --output-fd 3 3>&1
-	python2 setup.py build || return 1
-	python3 setup.py build || return 1
 }
-package() {
+check() {
-	mkdir -p "$pkgdir"
+	python3 -m venv --clear --system-site-packages testenv
+	testenv/bin/python3 -m installer .dist/*.whl
+	testenv/bin/python3 -m pytest
 }
-_py2() {
+package() {
-	replaces="$pkgname"
+	python3 -m installer -d "$pkgdir" \
-	_py python2
+		dist/*.whl
-}
-_py3() {
-	_py python3
-}
-_py() {
-	local python="$1"
-	pkgdesc="$pkgdesc (for $python)"
-	arch="all"
-	depends="$depends $python"
-	install_if="$pkgname=$pkgver-r$pkgrel $python"
-	cd "$builddir"
-	$python setup.py install --prefix=/usr --root="$subpkgdir"
 }
 </pre>
-Source located at [http://pypi.python.org PyPi]
+Depending on the <code>build-backend</code> in the pyproject.toml, the package should depend on py3-setuptools, py3-flit-core, py3-poetry-core or py3-hatchling at build time. If a project specifies literally <code>flit</code> or <code>poetry</code>, patch it to use the <code>-core</code> variant.
-<pre>
-_pkgname=ShortName
-...
-source="https://files.pythonhosted.org/packages/source/${_pkgname:0:1}/$_pkgname/$_pkgname-$pkgver.tar.gz"
-</pre>
 [[Category:Development]] [[Category:Python]]