Skip to main content

New python package to Fedora

A guide for complete newbies about what it takes to incorporate a python package to fedora from Packit project perspective.

Prerequsities​

  • You have python project on Github.

Create python package​

Create setup.py or setup.cfg with a package metadata. setup.{py|cfg} is the build script for setuptools.

Decide and setup versioning schema​

You can either manually set version in setup.py or let setuptools-scm do that for you.

Choose your scheme, eg 0.1.0. It depends on previous steps, if you have hardcoded version in setup.py, or used mechanism like git tags

  • Create git tag git tag 0.1.0 -a, then python setup will use this as version
  • Push the tag to origin git push --tags
  • Use tito project to increase versions

Upload package release to PYPI​

  • If you are not already registered, register to PYPI server
  • Build the package python3 setup.py sdist
  • Install twine: sudo dnf install python3-twine
  • Upload release: twine upload dist/your_package_name-0.1.0.tar.gz

Workflow to enable COPR builds of your packages​

Create Specfile​

  • Install pyp2rpm to convert your setup.py to a specfile: sudo dnf install pyp2rpm
  • Create specfile: pyp2rpm your_project_name > python-your_project_name.spec
  • pyp2rpm creates also section %check in your specfile. It may cause troubles in case you have no defined test in your setup.py, so replace it with your test command, or remove this section.

Install Packit-as-a-Service GitHub App​

See documentation.

Create .packit.yaml with copr build enabled​

Comprehensive documentation is available at packit.dev. Create file .packit.yaml with proper content and add it to git.

  • generic part example:
specfile_path: python-your_project_name.spec
# package project name what correspond to package name in setup.py
upstream_package_name: your_project_name
# name what you used as name in specfile (for python packages it starts with python-)
downstream_package_name: python-your_project_name
  • copr build enablement part of config - It enables copr builds for stable (without rawhide) fedora releases.
jobs:
  - job: copr_build
trigger: pull_request
metadata:
  targets:
    - fedora-stable
  • If you have static versioning scheme eg. version in spec, setup.py files it should work without next code, in case you are using versioning based on some scm tools, you have to add action to packit yaml (because .git is not part of tarball with package archive)
actions:
create-archive:
  - "python3 setup.py sdist --dist-dir ."
  - "sh -c 'echo your_project_name-$(python3 setup.py --version).tar.gz'"
get-current-version:
  - "python3 setup.py --version"

Then create pull request containing this .packit.yaml file. Packit service should try to do Copr builds for you to prove that Fedora RPM packages build fine.

Increase version and push it to git/PYPI already​

It is important to get to consistent state. Previous steps are important do to in this sequence, because it is important for specfile creation.

Troubleshooting​

  • If the package cannot be build - try to build SRPM package locally via packit CMD line tool: packit srpm

Workflow to add your package to Fedora​

Became Fedora package maintainer​

If you are not already Fedora packager, you have to become one.

Contribute new package to Fedora​

Follow instruction. It is quite complex process to incorporate some package to Fedora.