<commit_before>deb-pkg-tools: Debian packaging tools
=====================================

The Python package `deb-pkg-tools` is a collection of functions to work with
Debian packages and repositories. Some of those functions have a command line
interface (see below) because they're very convenient to use in shell scripts,
while other functions are meant to be called directly from Python code.

Status
------

On the one hand the `deb-pkg-tools` package is based on my experiences with
Debian packages and repositories over the past couple of years, on the other
hand `deb-pkg-tools` itself is quite young. Then again all functionality is
covered by automated tests; at the time of writing coverage is around 96% (some
of the error handling is quite tricky to test if we also want to test the
non-error case, which is of course the main focus :-)

Installation and usage
----------------------

You can install the `deb-pkg-tools` package using the following command::

    $ pip install deb-pkg-tools

After installation you'll have the ``deb-pkg-tools`` program available::

    $ deb-pkg-tools --help
    Usage: deb-pkg-tools [OPTIONS]

    Supported options:

      -i, --inspect=FILE         inspect the metadata in a *.deb archive
      -b, --build=DIR            build a Debian package with `dpkg-deb --build'
      -u, --update-repo=DIR      create/update a trivial package repository
      -a, --activate-repo=DIR    enable `apt-get' to install packages from a
                                 trivial repository (assumes root access)
      -d, --deactivate-repo=DIR  cleans up after --activate-repo
                                 (assumes root access)
      -v, --verbose              make more noise
      -h, --help                 show this message and exit

If you're interested in using `deb-pkg-tools` as a Python module, please refer
to the function reference on `Read the Docs`_.

Dependencies
------------

The `deb-pkg-tools` package depends on the python-debian_ package for control
file parsing. The following external programs are also required (depending on
which functionality you need of course):

=====================  =============
Program                Package
=====================  =============
``apt-ftparchive``     ``apt-utils``
``apt-get``            ``apt``
``ar``                 ``binutils``
``cat``                ``coreutils``
``cp``                 ``coreutils``
``dpkg-deb``           ``dpkg``
``dpkg-scanpackages``  ``dpkg-dev``
``du``                 ``coreutils``
``fakeroot``           ``fakeroot``
``gpg``                ``gnupg``
``gzip``               ``gzip``
``lintian``            ``lintian``
``mv``                 ``coreutils``
``sed``                ``sed``
``tar``                ``tar``
=====================  =============

Contact
-------

The latest version of `deb-pkg-tools` is available on PyPI_ and GitHub_. The
documentation is hosted on `Read the Docs`_. For bug reports please create an
issue on GitHub_. If you have questions, suggestions, etc. feel free to send me
an e-mail at `<EMAIL>`_.

License
-------

This software is licensed under the `MIT license`_.

© 2013 <NAME>.

.. External references:
.. _GitHub: https://github.com/xolox/python-deb-pkg-tools
.. _MIT license: http://en.wikipedia.org/wiki/MIT_License
.. _<EMAIL>: <EMAIL>
.. _PyPI: https://pypi.python.org/pypi/deb-pkg-tools
.. _python-debian: https://pypi.python.org/pypi/python-debian
.. _Read the Docs: https://deb-pkg-tools.readthedocs.org
<commit_msg>Test coverage is no longer at 96% :-( (it's more like 92%)<commit_after>deb-pkg-tools: Debian packaging tools
=====================================

The Python package `deb-pkg-tools` is a collection of functions to work with
Debian packages and repositories. Some of those functions have a command line
interface (see below) because they're very convenient to use in shell scripts,
while other functions are meant to be called directly from Python code.

Status
------

On the one hand the `deb-pkg-tools` package is based on my experiences with
Debian packages and repositories over the past couple of years, on the other
hand `deb-pkg-tools` itself is quite young. Then again most functionality is
covered by automated tests; at the time of writing coverage is around 90% (some
of the error handling is quite tricky to test if we also want to test the
non-error case, which is of course the main focus :-)

Installation and usage
----------------------

You can install the `deb-pkg-tools` package using the following command::

    $ pip install deb-pkg-tools

After installation you'll have the ``deb-pkg-tools`` program available::

    $ deb-pkg-tools --help
    Usage: deb-pkg-tools [OPTIONS]

    Supported options:

      -i, --inspect=FILE         inspect the metadata in a *.deb archive
      -b, --build=DIR            build a Debian package with `dpkg-deb --build'
      -u, --update-repo=DIR      create/update a trivial package repository
      -a, --activate-repo=DIR    enable `apt-get' to install packages from a
                                 trivial repository (assumes root access)
      -d, --deactivate-repo=DIR  cleans up after --activate-repo
                                 (assumes root access)
      -v, --verbose              make more noise
      -h, --help                 show this message and exit

If you're interested in using `deb-pkg-tools` as a Python module, please refer
to the function reference on `Read the Docs`_.

Dependencies
------------

The `deb-pkg-tools` package depends on the python-debian_ package for control
file parsing. The following external programs are also required (depending on
which functionality you need of course):

=====================  =============
Program                Package
=====================  =============
``apt-ftparchive``     ``apt-utils``
``apt-get``            ``apt``
``ar``                 ``binutils``
``cat``                ``coreutils``
``cp``                 ``coreutils``
``dpkg-deb``           ``dpkg``
``dpkg-scanpackages``  ``dpkg-dev``
``du``                 ``coreutils``
``fakeroot``           ``fakeroot``
``gpg``                ``gnupg``
``gzip``               ``gzip``
``lintian``            ``lintian``
``mv``                 ``coreutils``
``sed``                ``sed``
``tar``                ``tar``
=====================  =============

Contact
-------

The latest version of `deb-pkg-tools` is available on PyPI_ and GitHub_. The
documentation is hosted on `Read the Docs`_. For bug reports please create an
issue on GitHub_. If you have questions, suggestions, etc. feel free to send me
an e-mail at `<EMAIL>`_.

License
-------

This software is licensed under the `MIT license`_.

© 2014 <NAME>.

.. External references:
.. _GitHub: https://github.com/xolox/python-deb-pkg-tools
.. _MIT license: http://en.wikipedia.org/wiki/MIT_License
.. _<EMAIL>: <EMAIL>
.. _PyPI: https://pypi.python.org/pypi/deb-pkg-tools
.. _python-debian: https://pypi.python.org/pypi/python-debian
.. _Read the Docs: https://deb-pkg-tools.readthedocs.org

{'fraction_non_alphanumeric': 0.1558330967925064, 'fraction_numerical': 0.0022707919386886176, 'mean_word_length': 2.557294295810197, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1391934', 'n_tokens_mistral': 1994, 'n_tokens_neox': 1842, 'n_words': 756}