libdnf
Libdnf is a package management library. It was originally written to support the DNF package manager and grew up into a versatile library. Now you can use it for building custom tools that load repositories, query packages, resolve dependencies and install packages.
It is powered with libsolv, wrapping it with an easy to use programming interface.
-
Libdnf supports working with the following artifacts:
- RPM repositories (repomd)
- RPM packages
- Comps groups
- Comps environments
- Advisories (updateinfo, errata)
- Modules (modulemd)
Libdnf interfaces with several programming languages with the following support:
- C++ - fully supported
- Python 3 - fully supported
- Perl 5 - best effort
- Ruby - best effort
- Go - doesn't work, looking for contributors
- C - not implemented, doesn't seem to be a priority for any of our existing API users
Documentation
- For HTML documentation see https://libdnf.readthedocs.io/
- The header files are documented because documentation is mainly generated from them
Reporting issues
- Red Hat Bugzilla is the preferred way of filing issues. [backlog]
- GitHub issues are also accepted. [backlog]
Contributing
- By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document is a simple statement that you, as a contributor, have the legal right to submit the contribution. See the DCO file for details.
- All contributions to this project are licensed under LGPLv2.1+ or GPLv2+. See the License section for details.
Writing patches
- Please follow the contributing guidelines
- When a patch is ready, submit a pull request
- It is a good practice to write documentation and unit tests as part of the patches
Building
To install build requirements, run::
$ dnf builddep libdnf.spec --define '_with_sanitizers 1' [--define '_without_<option> 1 ...]
To build code, run::
$ mkdir build
$ cd build
$ cmake .. -DWITH_SANITIZERS=ON [-DWITH_<OPTION>=<ON|OFF> ...]
$ make -j4
To build rpms from git, run::
$ export PREFIX=$(rpmspec libdnf.spec -q --srpm --qf '%{name}-%{version}'); git archive --format=tar.gz --prefix=$PREFIX/ HEAD > $PREFIX.tar.gz
$ rpmbuild -ba --define "_sourcedir $(pwd)" libdnf.spec [--with=<option>|--without=<option> ...]
Testing
To run the tests, follow the steps to build the code and then run::
# from the 'build' directory
$ CTEST_OUTPUT_ON_FAILURE=1 make test
As an alternative, tests can be executed in a verbose mode::
# from the 'build' directory
$ make test ARGS='-V'
Translating
TBD