Py2pack: Generate distribution packages from PyPI

.. image:: https://github.com/openSUSE/py2pack/actions/workflows/tox.yml/badge.svg :target: https://github.com/openSUSE/py2pack/actions/workflows/tox.yml :alt: Unit tests

This script allows to generate RPM spec or DEB dsc files from Python modules. It allows to list Python modules or search for them on the Python Package Index (PyPI). Conveniently, it can fetch tarballs and changelogs making it an universal tool to package Python modules.

Installation

To install py2pack from the Python Package Index_, simply:

.. code-block:: bash

$ python3 -mpip install py2pack

You can also check your distro of choice if they provide packages. For openSUSE Tumbleweed and Leap 15.X, you can

.. code-block:: bash

$ sudo zypper install python3-py2pack

Usage

Lets suppose you want to package zope.interface_ and you don't know how it is named exactly. First of all, you can search for it and download the source tarball if you found the correct module:

.. code-block:: bash

$ py2pack search zope.interface
searching for module zope.interface...
found zope.interface-3.6.1
$ py2pack fetch zope.interface
downloading package zope.interface-3.6.1...
from http://pypi.python.org/packages/source/z/zope.interface/zope.interface-3.6.1.tar.gz

As a next step you may want to generate a package recipe for your distribution. For RPM_-based distributions (let's use openSUSE_ as an example), you want to generate a spec file (named 'python-zope.interface.spec'):

.. code-block:: bash

$ py2pack generate zope.interface -t opensuse.spec -f python-zope.interface.spec

The source tarball and the package recipe is all you need to generate the RPM_ (or DEB_) file. This final step may depend on which distribution you use. Again, for openSUSE_ (and by using the Open Build Service_), the complete recipe is:

.. code-block:: bash

$ osc mkpac python-zope.interface
$ cd python-zope.interface
$ py2pack fetch zope.interface
$ py2pack generate zope.interface -f python-zope.interface.spec
$ osc build
...

Depending on the module, you may have to adapt the resulting spec file slightly. To get further help about py2pack usage, issue the following command:

.. code-block:: bash

$ py2pack help

Hacking and contributing

You can test py2pack from your git checkout by executing the py2pack module.

Edit py2pack/version.py file changing the version number. Adding +1 to the revision number and optionally appending .dev1 is enough and makes sure that you can distinguish your hackish version from an installed one.

From the py2pack directory, install the py2pack module locally.

.. code-block:: bash

$ pip install -e .

Now you can run your hackish py2pack version. It is usually located in $HOME/.local/bin/py2pack

.. code-block:: bash

$ py2pack

Fork the repository_ on Github to start making your changes to the master branch (or branch off of it). Don't forget to write a test for fixed issues or implemented features whenever appropriate. You can invoke the testsuite from the repository root directory via tox_:

.. code-block:: bash

$ tox

To run a single test class via tox_, use i.e.:

.. code-block:: bash

$ tox -epy38 test.test_py2pack:Py2packTestCase

You can also run pytest_ directly:

.. code-block:: bash

$ pytest

It assumes you have the test dependencies installed (available on PYTHONPATH) on your system.

:copyright: (c) 2013 Sascha Peilicke. :license: Apache-2.0, see LICENSE for more details.

.. _argparse: http://pypi.python.org/pypi/argparse .. _Jinja2: http://pypi.python.org/pypi/Jinja2 .. _zope.interface: http://pypi.python.org/pypi/zope.interface/ .. _openSUSE: http://www.opensuse.org/en/ .. _RPM: http://en.wikipedia.org/wiki/RPM_Package_Manager .. _DEB: http://en.wikipedia.org/wiki/Deb_(file_format) .. _Python Package Index: https://pypi.org/ .. _Open Build Service: https://build.opensuse.org/package/show/devel:languages:python/python-py2pack .. _the repository: https://github.com/openSUSE/py2pack .. _pytest: https://github.com/pytest-dev/pytest .. _tox: http://testrun.org/tox