What is pkgcore?

pkgcore is a framework for package management; via the appropriate class plugins, the design should allow for any underlying repository/config/format to be used; slackware's tgzs being exempted due to lack of any real metadata, and autopackage format being exempted due to the fact they effectively embed the manager in each package (pkgcore does require being able to treat the pkg as data, instead of autopackage's method of handing resolution/all manager ops off to the package script).

What does pkgcore require?

At least python verison 2.7, and snakeoil_ — a utility library with misc optimizations split out of pkgcore for others to use.

Who to contact if I find a bug?

Please submit an issue via Github. You can also stop by at #pkgcore on Freenode.

Tools

pclonecache: clone a repository cache

pebuild: low-level ebuild operations, go through phases manually

pinspect: generic utility for inspecting repository related info

pmaint: generic utility for repository maintenance (syncing, copying...)

pmerge: generic utility for doing dependency resolution, fetching, (un)merging, etc.

pquery: generic utility for querying info about repositories, revdeps, pkg search, vdb search, etc.

Documentation

Please take a look at either doc/ and dev-notes/ ; additionally, the code for the most part has docstrings, thus pydoc is a good reference.

The introduction docs are good if you're just getting started. If you want to start hacking, take a look at the development docs.

In addition, html documentation is available at readthedocs, alternative formats are also available for download.

Tests

A standalone test runner is integrated in setup.py; to run, just execute::

python setup.py test

Aside from that, our runner of choice is twisted's trial; ran via::

trial pkgcore

If you're doing development, trial is significantly friendlier; the standalone runner is designed to be mainly used for installations of pkgcore, where all tests must pass, else installation is aborted.

Installing

To build::

tar jxf pkgcore-0.XX.tar.bz2
cd pkgcore-0.XX
python setup.py build

Run tests::

cd pkgcore-0.xx
python setup.py test
 or
trial pkgcore

To install::

cd pkgcore-0.xx
python setup.py install
pplugincache

.. _snakeoil: https://github.com/pkgcore/snakeoil .. _Github: https://github.com/pkgcore/pkgcore/issues .. Gentoo Bugzilla: https://bugs.gentoo.org .. #pkgcore: https://webchat.freenode.net?channels=%23pkgcore&uio=d4 .. _introduction docs: http://pkgcore.readthedocs.org/en/latest/getting-started.html .. _development docs: http://pkgcore.readthedocs.org/en/latest/dev-notes/developing.html .. _readthedocs: http://pkgcore.readthedocs.org/ .. _download: https://readthedocs.org/projects/pkgcore/downloads/