Chenxiong QiIntroduction
rpkg2 is a project forked from rpkg to introduce various major improvements and refactor in order to:
- Modern modularization.
- A real library for import from other projects to operate package repository or access package metadata.
- Extensible for writing package client tool.
- A framework to write subcommands in a decoupled way to build artifacts, including RPMs, modules, or containers.
- Remove all deprecation and technical debt.
- Python 3 default apparently.
rpkg works with Python 2.6, 2.7, 3.5, 3.6 and 3.7.
Usage Examples
Retrieve package repository information:
from pyrpkg.pkgrepo import PackageRepository
repo = PackageRepository('/path/to/package')
print(repo.branch_merge)
print(repo.branch_remote)
print(repo.push_url)
print(repo.commit_hash)
Retrieve package metadata:
from pyrpkg.pkgrepo import PackageRepository
from pyrpkg.pkginfo import PackageMetadata
repo = PackageRepository('/path/to/package')
pkg = PackageMetadata(repo)
print(pkg.ns)
print(pkg.ns_repo_name)
print(pkg.disttag)
print(pkg.spec)
Read and access configuration:
from pyrpkg.config import read_config
config = read_config('/path/to/rpkg.config')
print(config.rpkg.anongiturl)
print(config.rpkg.distgit_namespaced)
License
Unless otherwise specified, all files are licensed under GPLv2+.
Installation
Install from distribution packages
rpkg is available in Fedora and EPEL repositories. It can be installed with package manager command. There are Python 2 and 3 package for Fedora and only Python 2 package in EPEL.
Install in a Fedora system:
sudo dnf install python2-rpkg
If Python 3 package is needed, install python3-rpkg.
Install in EL6 or EL7:
sudo yum install python2-rpkg
Install in a Python virtual environment
Both Python 2 and 3 packages are published in PyPI. Install rpkg in a Python 3 virtual environment in these steps:
python3 -m venv env source env/bin/activate pip install rpkg rpm-py-installer
You are free to create a virtual environment with option --system-site-packages.
Please note that, rpkg depends on some other utilities to build packages. These packages are required to be installed as well.
mock: for local mockbuild.rpm-build: for local RPM build, which provides the command linerpm.rpmlint: check SPEC.copr-cli: for building package in Fedora Copr.module-build-service: for building modules.
Contribution
You are welcome to write patches to fix or improve rpkg. All code should work with Python 2.6, 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.
Run Tests
Before make a pull request, ensure local changes pass all test cases.
Before run tests, install these packages:
sudo dnf install python26 python37 detox python2-virtualenv
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.
More Information
See https://pagure.io/rpkg2 for more information, bug tracking, etc.