fedora-docs-l10n/packaging-guidelines/master/pages/Python — English @ Fedora Weblate: *Every* package that uses Python (at run-time and/or build-time) and/or …

Zen

Source string Source string

English

*Every* package that uses Python (at run-time and/or build-time)
and/or installs Python modules
*MUST* have a build-time dependency on `+python3-devel+`,
even if Python is not actually invoked during build-time.
Such a package *MUST* use one of the following in its `+.spec+` file:

Needs editing

The string is read only.

Skip

	English	Actions
	Python Packaging Guidelines
	This version of Python Packaging Guidelines is in effect since 2021 and represents a major rewrite and paradigm shift. Not all packages are updated to reflect this. Older guidelines are still being kept up to date, and existing packages MAY use them instead of this document:
	xref:Python_201x.adoc[“201x-era” Python packaging guidelines] (Packages using these usually use the <<py3_install,`+%py3_install+`>> or <<py3_install_wheel,`+%py3_install_wheel+` macro>> or call `+setup.py install+`.)
	xref:Python_Appendix.adoc#_python_2_packages[Python 2 appendix] Note that Python 2 packages require a FESCo exception.
	These guidelines only support current Fedora releases. For older releases (such as in EPEL 8), consult the xref:Python_201x.adoc[201x-era guidelines].
	The two <<Distro-wide guidelines>> below apply to all software in Fedora that uses Python at build- or run-time.
	The rest of the Guidelines apply to packages that ship code that can be imported with Python’s `+import+` statement. Specifically, that is all packages that install files under `+/usr/lib/python/+`.
	Except for the two “Distro-wide guidelines”, these Guidelines do not apply to simple one-file scripts or utilities, especially if these are included with software not written in Python. However, if an application (e.g. CLI tool, script or GUI app) needs a more complex Python library, the library SHOULD be packaged as an importable library under these guidelines.
	A major goal for Python packaging in Fedora is to _harmonize with the wider Python ecosystem_, that is, the https://pypa.io[Python Packaging Authority] (PyPA) standards and the https://pypi.org/[Python Package Index] (PyPI). Packagers SHOULD be prepared to get involved with upstream projects to establish best practices as outlined here. We wish to improve both Fedora and the wider Python ecosystem.
	Some build tools (like CMake or autotools) may not work with the latest PyPA standards yet. (For example, they might generate `+.egg-info+` directories rather than `+.dist-info+`.) While this document's normative points (MUST/SHOULD) are tool-agnostic, many of the practical tips and helper macros will not be applicable. If this affects you, consider contacting the https://lists.fedoraproject.org/archives/list/python-devel@lists.fedoraproject.org/[Python SIG] for guidance and/or following the xref:Python_201x.adoc[older guidelines] for the time being.
	Fedora’s Python SIG not only develops these guidelines, but it’s also involved in PyPA standards and Python packaging best practices. Check out https://fedoraproject.org/wiki/SIGs/Python[the wiki] or https://lists.fedoraproject.org/archives/list/python-devel@lists.fedoraproject.org/[mailing list] if you need help or wish to help out.
	Distro-wide guidelines
	Build-time dependency on python3-devel
	Every package that uses Python (at run-time and/or build-time) and/or installs Python modules MUST have a build-time dependency on `+python3-devel+`, even if Python is not actually invoked during build-time. Such a package MUST use one of the following in its `+.spec+` file:
	<<pyproject_buildrequires,`+%pyproject_buildrequires+`>> in the `+%generate_buildrequires+` section
	`+BuildRequires: python3-devel+`
	Only having a transitive build-time dependency on `+python3-devel+` is not sufficient. If the package uses an alternate Python interpreter instead of `+python3+` (e.g. `+pypy+`, `+jython+`, `+python2.7+`), it MAY instead require the corresponding `+*-devel+` package.
	The `+*-devel+` package brings in relevant RPM macros. It may also enable automated or manual checks: for example, Python maintainers use this requirement to list packages that use Python in some way and might be affected by planned changes.
	Mandatory macros
	The following macros MUST be used where applicable.
	The expansions in parentheses are provided only as reference/examples.
	The macros are defined for you in all supported Fedora and EPEL versions.
	`+%{python3}+` (`+/usr/bin/python3+`): The Python interpreter. For example, this macro should be used for invoking Python from a `+spec+` file script, passed to `+configure+` scripts to select a Python executable, or used as `+%{python3} -m pip+` to run a Python-based tool.
	If the packaged software invokes Python at _run time_ (as opposed to running Python to build/test it), it might be necessary to pass flags to `+%{python3}+` to isolate it from user-installed packages. See <<Shebangs>> for details.
	`+%{python3_version}+` (e.g. `+3.9+`, `+3.10+`): Version of the Python interpreter.
	`+%{python3_version_nodots}+` (e.g. `+39+`, `+310+`): Version of the Python interpreter without the dot.
	`+%{python3_sitelib}+` (e.g. `+/usr/lib/python3.9/site-packages+`): Where pure-Python modules are installed.
	`+%{python3_sitearch}+` (e.g. `+/usr/lib64/python3.9/site-packages+`): Where Python extension modules (native code, e.g. compiled from C) are installed.
	The rest of this document uses these macros, along with `+%{_bindir}+` (`+/usr/bin/+`), instead of the raw path names.

Loading…

None

String added in the repository

English

English 282 characters edited Current translation Read only

3 months ago

Browse all string changes

Things to check

Multiple failing checks

Following checks are failing:
Mismatching line breaks: Portuguese (Brazil), Portuguese (Brazil)

Reset

Glossary

English	English
No related strings found in the glossary.

18363060 String information

Source string description

type: Plain text

Flags

no-wrap, placeholders:r"`pass:\[.\]`":r"\`\+[\w\d/\*-_%\.{}\(\) \']*\+\`":r"`[\w-]*`":r"xref\:[\w\d_-]*(\.adoc)?(#[\w\d_-]*)?":r"\[\[[\w_-]*\]\]", read-only

Source string location

./pages/Python.adoc:110

String age

3 months ago

Last updated

3 months ago

Source string age

3 months ago

Translation file

pot/master/pages/Python.pot, string 14

Shortcut	Action
`?`	Open available keyboard shortcuts.
`Alt` + `Home`	Navigate to the first translation in the current search.
`Alt` + `End`	Navigate to the last translation in the current search.
`Alt` + `PageUp` or `Ctrl` + `↑` or `Alt` + `↑` or `Cmd` + `↑` or	Navigate to the last translation in the current search.
`Alt` + `PageDown` or `Ctrl` + `↓` or `Alt` + `↓` or `Cmd` + `↓` or	Navigate to the next translation in the current search.
`Ctrl` + `Enter` or `Cmd` + `Enter`	Submit current form; this works the same as pressing Save and continue while editing translation.
`Ctrl` + `Shift` + `Enter` or `Cmd` + `Shift` +`Enter`	Unmark translation as Needing edit and submit it.
`Alt` + `Enter` or `Option` + `Enter`	Submit the string as a suggestion; this works the same as pressing Suggest while editing translation.
`Ctrl` + `E` or `Cmd` + `E`	Focus on translation editor.
`Ctrl` + `U` or `Cmd` + `U`	Focus on comment editor.
`Ctrl` + `M` or `Cmd` + `M`	Shows Automatic suggestions tab.
`Ctrl` + `1` to `Ctrl` + `9` or `Cmd` + `1` to `Cmd` + `9`	Copies placeable of a given number from source string.
`Ctrl` + `M` followed by `1` to `9` or `Cmd` + `M` followed by `1` to `9`	Copy the machine translation of a given number to current translation.
`Ctrl` + `I` followed by `1` to `9` or `Cmd` + `I` followed by `1` to `9`	Ignore one item in the list of failing checks.
`Ctrl` + `J` or `Cmd` + `J`	Shows the Nearby strings tab.
`Ctrl` + `S` or `Cmd` + `S`	Focus on search field.
`Ctrl` + `O` or `Cmd` + `O`	Copy the source string.
`Ctrl` + `Y` or `Cmd` + `Y`	Toggle the Needs editing checkbox.
`→`	Browse the next translation string.
`←`	Browse the previous translation string.