Skip to main content


Project description


The ``pkgme`` program is a framework for generating Debian packaging artifacts
from information gleaned from inspecting the code. The framework takes care
of the common tasks, and knows about packaging in general. It is extensible
so that programming language-specific conventions and rules can be supported.

Project information

``pkgme`` development is `hosted on Launchpad`_. Please see the project page
for downloads, bug reports, and accessing the latest code (available in the
Bazaar_ version control system). You can also subscribe to the `pkgme mailing
list`_ for discussions on using and extending ``pkgme``. The archives_ are
also available on-line.

.. _`hosted on Launchpad`:
.. _Bazaar:
.. _`pkgme mailing list`:
.. _archives:


In addition to the various Python modules documented in ````,
``pkgme`` depends on ``devscripts`` and ``debhelper``.


Right now, the best way to hack on ``pkgme`` is in a virtualenv_. This allows
you to hack on ``pkgme`` in a clean environment, without touching or changing
your system Python. You will need access to the internet in order to install
``pkgme`` into your virtualenv. On Debian/Ubuntu, make sure you have the
`python-virtualenv` package installed, then do the following::

% virtualenv /arbitrary/path
% source /arbitrary/path/bin/activate
% python develop

If you want to override the default location of the backends, set the
environment variable ``$PKGME_BACKEND_PATHS``. This is a colon-separated list
of directories, for example:

% export PKGME_BACKEND_PATHS=/pkgme/foo-backends:/pkgme/bar-backends
% cd my-about-to-be-packaged-code
% pkgme

When you're done, just run the ``deactivate`` command and blow away


While in your virtualenv, you can run the full test suite like so::

% python test

Building the documentation

If you have the Sphinx toolchain installed (on Debian/Ubuntu, the
python-sphinx package), you can build the documentation like so::

% make html

You'll need to be in your virtualenv, and you should have installed ``pkgme``
in that virtualenv before trying to build the documentation.

.. _virtualenv:

Table of Contents

.. toctree::

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <>.

NEWS for pkgme

0.3 (2012-08-03)

* New release, lots of new features.

0.2 (201X-XX-XX)

0.1 (201X-XX-XX)
* Initial release.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pkgme-0.3.tar.gz (69.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page