Introduction
============

This is the fedpkg project, which mostly is a subclass of the rpkg project.

rpkg works with Python 2.7, 3.6, 3.7 and 3.8.

License
=======

Unless otherwise specified, all files are licensed under GPLv2+.

Installation
============

Install from distribution packages
----------------------------------

fedpkg is available in Fedora and EPEL repositories. It can be installed with
package manager command. There is Python 3 package for Fedora and EPEL8;
and Python 2 package in EPEL7.

Install in a Fedora system::

    sudo dnf install fedpkg

Install in EPEL7::

    sudo yum install fedpkg

Install in EPEL8::

    sudo dnf install fedpkg
Contribution
============

You are welcome to write patches to fix or improve rpkg. All code should work
with Python 2.7 and 3. Before you create a PR to propose your changes,
make sure

Sign-off commit
---------------

Make sure to sign-off your commits by ``git commit -s``. This serves as a
confirmation that you have the right to submit your changes. See `Developer
Certificate of Origin`_ for details.

.. _Developer Certificate of Origin: https://developercertificate.org/

Run Tests
---------

Before make a pull request, ensure local changes pass all test cases.

Before run tests, install these packages::

    sudo dnf install python27 python36 python37 git make gcc rpm-build \
    libcurl-devel krb5-devel openssl-devel

To run tests simply, ``make test``.

By default, target ``test`` runs tests with all supported Python versions.
However, if you look into ``Makefile``, there is still a target ``tox`` that
allows developer to run tests with test environments one by one.

Links
=====

* Documentation: https://docs.pagure.org/fedpkg
* Upstream GIT: https://pagure.io/fedpkg
* Issue tracker: https://pagure.io/fedpkg/issues