distutilazy 0.4.1

Extra distutils commands

Extra distutils commands, including:

• clean_pyc: clean compiled python files

• clean_jython_class: clean compiled .class files created by Jython

• clean_all: using distutils.clean, clean_pyc and clean_jython_class to clean all temporary files

• bdist_pyinstaller: convenient calls for PyInstaller with sane defaults

• test: run unit tests

Installation

Use pip to install from PyPI:

$ pip install distutilazy

To install from the source, download the source and run

$ python setup.py install

There are no specific dependencies, distutilazy runs on Python 2.7+ (CPython 2.7, 3.2, 3.3, 3.4 and 3.5, PyPy 2.6 and PyPy3 2.4 are tested). Tests pass on Jython so it should be fine for Jython as well.

How

After installing distutilazy, add distutilazy.command package to the list of command packages in your setup.cfg file.

[global]
command_packages = distutilazy.command

That’s it. Now you may use new commands directly from your setup.py.

To run unit tests (using standard library unittest) in your project (by default runs tests/test*.py files from current path):

$ python setup.py test

To clean compiled python files:

$ python setup.py clean_pyc

To clean all temporary files (build artifacts, compiled files created by CPython or Jython, etc.):

$ python setup.py clean_all

Available commands are in distutilazy.command package, each command as a separate module.

To use custom command names for the same functionality, use command classes defined in distutilazy modules (each module might define more than a single command class).

The modules should be imported in setup.py, then desired classes might be assigned to command names using the cmdclass parameter.

import distutilazy.clean

setup(
    cmdclass: {
        'clean_pyc': distutilazy.clean.CleanPyc,
        'clean_jython': distutilazy.clean.CleanJythonClass,
        'clear': distutilazy.clean.CleanAll
    }
)

To extend (or customize) the behavior of the command classes define a class extending from these command classes, and use that custom class in cmdclass.

Development

• Code is hosted on GitHub.

• Documentations are on Read The Docs.

Tests

If you have make available

$ make test

You can always use setup.py to run tests:

$ python setup.py test

License

Distutilazy is released under the terms of MIT license.