From Fedora Project Wiki
(First draft)
 
Line 13: Line 13:
 
* Name: [[User:Churchyard| Miro Hroncok]]
 
* Name: [[User:Churchyard| Miro Hroncok]]
 
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
 
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
* Email: torsava@redhat.com
+
* Email: python-maint@redhat.com
 
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
 
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
 
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)

Revision as of 15:22, 24 June 2016

Automatic PyPI Provides for Python RPM Packages

Summary

Upon building Python packages containing packaging metadata, RPM will automatically detect the canonical name[1] of the software on PyPI (Python Package Index) and create a virtual Provides tag with the value pythonX.Ydist(PYPI_CANONICAL_NAME), where X.Y is the used Python version. RPM may also detect dependencies of the software from the metadata and automatically require them using the same syntax.

Owner

Current status

  • Targeted release: Fedora 25
  • Last updated: 2016-06-24
  • Tracker bug: <will be assigned by the Wrangler>

Detailed Description

The metadata needed for the provides/dependency generator are standard Python metadata in .egg-info/.egg-link/.dist-info files that are provided in Python Wheels and Eggs. Because these files don't always contain the full list of requirements (which are either in setup.py or requirements.txt), the dependency generator will not be conclusive.

Note that the virtual Provides tags as well as the dependencies will be generated using the PyPI canonical name, which can differ slightly from the name displayed on PyPI.[1]

All Python packages will need to be rebuilt so that the virtual Provides tags are generated for them so that the dependency generator can start working.

Benefit to Fedora

Packaging Python software will become easier, and (semi-)automatic tools for creating Python packages like pyp2rpm [1] will be significantly more effective due to this change.

Scope

  • Proposal owners: Prepare a draft for the Fedora Packaging Guidelines for Python
  • Maintainers of the RPM package: Backport the functionality from upsteram to Fedora. — Already done thanks to Florian Festi [2]
  • Release engineering: Targeted rebuild of Python packages. Ticket [3].
    • List of deliverables: All Fedora deliverables will be affected, but only in a very minor way that in no way jeopardizes their delivery.
  • Policies and guidelines: Fedora Packaging Guidelines for Python need to be updated after the implementation so users know how to take advantage of the change.
  • Trademark approval: Not needed for this Change

Upgrade/compatibility impact

No issues expected of any kind.

How To Test

0. Pick any Python software that is both packaged for Fedora and present on PyPI.

1. dnf install pythonX.Ydist(PYPI_CANONICAL_NAME) where X.Y is one of the Python versions for which the software is packaged in Fedora (for Fedora 24 it is most likely 3.5 and/or 2.7) and inside the parentheses is the name of the software on PyPI in its canonical format.[1]

Expected results: The correct package is installed.

User Experience

Users will be able to use dnf to install software from PyPI without knowing under what name the software is packaged in Fedora.

Dependencies

None

Contingency Plan

  • Contingency mechanism: Do not update the Fedora Packaging Guidelines
  • Contingency deadline: Alpha Freeze
  • Blocks release? No
  • Blocks product? None

Documentation

  • Information about the backport of this feature on Bugzilla. [4]
  • Descriptive commit message on RPM upstream: [5]
  • Python-devel mailing list discussion: [6]

Release Notes

Notes

  1. 1.0 1.1 1.2 The canonical name is obtained by switching the PyPI name to lower case and converting all non-alphanumeric runs to single “-” characters. Example: “The $$$ Tree” becomes “the-tree”.