Python package policies - Revision history

WhyNotHugo: /* Package template */ Remove reference to python2 packages

2024-02-26T13:18:20Z

Package template: Remove reference to python2 packages

← Older revision		Revision as of 13:18, 26 February 2024
Line 19:		Line 19:

	=== Package template ===		=== Package template ===

	Note that if you are removing python2 support from a package which previously had it, you should add <pre>replaces="py2-example"</pre> as well. If the old package was a split package, also add <pre>replaces="py-example"
	~~provides="py-example=$pkgver-r$pkgrel"</pre>.~~

	<pre># Maintainer: Joe Bloe <joe@example.org>		<pre># Maintainer: Joe Bloe <joe@example.org>

WhyNotHugo: /* Guidelines */ Formatting

2024-02-26T13:17:38Z

Guidelines: Formatting

← Older revision		Revision as of 13:17, 26 February 2024
Line 5:		Line 5:
	== Guidelines ==		== Guidelines ==

	* Prefix Python 3 libraries with py3-. Do not prefix programs (distinct from libraries) at all.		* Prefix Python 3 libraries with <code>py3-</code>. Do not prefix programs (distinct from libraries) at all.

	== General Template ==		== General Template ==

WhyNotHugo: /* Python 2 deprecation */ Remove section; python2 is history

2024-02-26T13:17:02Z

Python 2 deprecation: Remove section; python2 is history

← Older revision		Revision as of 13:17, 26 February 2024
Line 83:		Line 83:

	TODO: obtain consensus and organize this work.		TODO: obtain consensus and organize this work.

	~~=== Python 2 deprecation ===~~

	~~{{Draft\|Pending consensus on this approach}}~~

	~~The general approach to Python 2 deprecation and removal requires three broad steps:~~

	~~# Do not add new python 2 packages to aports, effective immediately.~~
	~~# In the course of the aports normalization project, drop Python 2 support if it's easy or triage it and make a note for later if not.~~
	# Making judgement calls for difficult packages on a case-by-case basis, based on the upstream's progress/amicability towards a Python 3 port. Upstreams which are unwilling to port to Python 3 should be removed from aports.

	~~TODO: Prepare some discussion place, git repos, scripts, etc, to organize this work.~~


	[[category: python]]		[[category: python]]

WhyNotHugo: /* setup.py does not exist */ Formatting

2024-02-26T13:16:26Z

setup.py does not exist: Formatting

← Older revision		Revision as of 13:16, 26 February 2024
Line 72:		Line 72:
	=== setup.py does not exist ===		=== setup.py does not exist ===

	In case a package uses a pyproject.toml instead of setup.py, you can use py3-gpep517+py3-installer. See ~~community/~~py3-rich for an example. ~~Things usually need~~ either py3-poetry-core/py3-flit-core or just py3-wheel/py3-setuptools in makedepends alongside py3-gpep517 to build successfully (~~read~~ the ~~pyproject.toml `~~build-backend~~` to figure out which)~~. ~~Also note how~~ to ~~run tests against~~ the ~~built package in that example~~.		In case a package uses a <code>pyproject.toml</code> instead of <code>setup.py</code>, you can use <code>py3-gpep517</code> and <code>py3-installer</code>. See {{Pkg\|py3-rich}} for an example. Also note how to run tests against the built package in that example.

			Many projects require either <code>py3-poetry-core</code>/<code>py3-flit-core</code> or just <code>py3-wheel</code>/<code>py3-setuptools</code> in makedepends alongside <code>py3-gpep517</code> to build successfully (check the <code>build-backend</code> in <code>pyproject.toml</code> to confirm the exact requirements).

	== Alpine+Python projects ==		== Alpine+Python projects ==

WhyNotHugo: /* Upstream uses 'tox' to run tests */ Reword

2024-02-26T13:13:58Z

Upstream uses 'tox' to run tests: Reword

← Older revision		Revision as of 13:13, 26 February 2024
Line 66:		Line 66:
	=== Upstream uses 'tox' to run tests ===		=== Upstream uses 'tox' to run tests ===

	tox (~~knows~~ as py3-tox ~~on Alpine Linux~~) downloads all dependencies into a virtual environment ~~by default, which~~ bypasses the system ~~tooling, making~~		tox (packaged as {{Pkg\|py3-tox}}) downloads all dependencies into a virtual environment. This bypasses the system packages negating a lot of the value in these tests.
	~~testing somewhat less useful~~.

	~~Remember to~~ use --sitepackages on your invocation of tox in the check() phase so it uses the system packages instead of downloading ones into		You can use <code>--sitepackages</code> on your invocation of tox in the check() phase so it uses the system packages instead of downloading ones into a virtual environment.
	a virtual environment.

	=== setup.py does not exist ===		=== setup.py does not exist ===

WhyNotHugo: /* You need to use the 'tox' utility to run tests */ Reword potentially misleading subtitle

2024-02-26T13:11:39Z

You need to use the 'tox' utility to run tests: Reword potentially misleading subtitle

← Older revision		Revision as of 13:11, 26 February 2024
Line 64:		Line 64:
	Watch out for this and be sure to add any of these packages to checkdepends so that setuptools isn't downloading and testing against packages/versions which aren't in aports.		Watch out for this and be sure to add any of these packages to checkdepends so that setuptools isn't downloading and testing against packages/versions which aren't in aports.

	=== ~~You need to use the~~ 'tox' ~~utility~~ to run tests ===		=== Upstream uses 'tox' to run tests ===

	tox (knows as py3-tox on Alpine Linux) downloads all dependencies into a virtual environment by default, which bypasses the system tooling, making		tox (knows as py3-tox on Alpine Linux) downloads all dependencies into a virtual environment by default, which bypasses the system tooling, making

Psykose: gpep517

2023-04-20T08:58:03Z

gpep517

← Older revision		Revision as of 08:58, 20 April 2023
Line 74:		Line 74:
	=== setup.py does not exist ===		=== setup.py does not exist ===

	In case a package uses a pyproject.toml instead of setup.py, you can use py3-~~build~~+py3-installer. See community/py3-rich for an example. Things usually need either py3-poetry-core/py3-flit-core or just py3-wheel/py3-setuptools in makedepends alongside py3-~~build~~ to build successfully (read the pyproject.toml `build-backend` to figure out which). Also note how to run tests against the built package in that example.		In case a package uses a pyproject.toml instead of setup.py, you can use py3-gpep517+py3-installer. See community/py3-rich for an example. Things usually need either py3-poetry-core/py3-flit-core or just py3-wheel/py3-setuptools in makedepends alongside py3-gpep517 to build successfully (read the pyproject.toml `build-backend` to figure out which). Also note how to run tests against the built package in that example.

	== Alpine+Python projects ==		== Alpine+Python projects ==

Psykose: python

2022-08-15T15:24:38Z

python

← Older revision		Revision as of 15:24, 15 August 2022
Line 47:		Line 47:

	package() {		package() {
	python3 setup.py install ~~--prefix=/usr~~ --root="$pkgdir"		python3 setup.py install --root="$pkgdir" --skip-build
	}</pre>		}</pre>

Psykose: replace pyproject2setuppy with py3-build in example

2022-04-08T17:55:07Z

replace pyproject2setuppy with py3-build in example

← Older revision		Revision as of 17:55, 8 April 2022
Line 74:		Line 74:
	=== setup.py does not exist ===		=== setup.py does not exist ===

	In case a package uses a pyproject.toml instead of setup.py, you can use ~~[https://github~~.~~com/mgorny~~/~~pyproject2setuppy pyproject2setuppy]. You can use gvm~~-~~tools as reference~~ for ~~how to use it: https://gitlab~~.~~alpinelinux.org~~/~~alpine/aports~~/-~~/tree/master/community/gvm~~-~~tools~~.		In case a package uses a pyproject.toml instead of setup.py, you can use py3-build+py3-installer. See community/py3-rich for an example. Things usually need either py3-poetry-core/py3-flit-core or just py3-wheel/py3-setuptools in makedepends alongside py3-build to build successfully (read the pyproject.toml `build-backend` to figure out which). Also note how to run tests against the built package in that example.

	== Alpine+Python projects ==		== Alpine+Python projects ==

Newbyte: Add note about projects not shipping a setup.py

2021-06-17T15:46:03Z

Add note about projects not shipping a setup.py

← Older revision		Revision as of 15:46, 17 June 2021
Line 71:		Line 71:
	Remember to use --sitepackages on your invocation of tox in the check() phase so it uses the system packages instead of downloading ones into		Remember to use --sitepackages on your invocation of tox in the check() phase so it uses the system packages instead of downloading ones into
	a virtual environment.		a virtual environment.

			=== setup.py does not exist ===

			In case a package uses a pyproject.toml instead of setup.py, you can use [https://github.com/mgorny/pyproject2setuppy pyproject2setuppy]. You can use gvm-tools as reference for how to use it: https://gitlab.alpinelinux.org/alpine/aports/-/tree/master/community/gvm-tools.

	== Alpine+Python projects ==		== Alpine+Python projects ==