Metadata-Version: 2.1
Name: pybuilder
Version: 0.11.17
Summary: PyBuilder
Home-page: http://pybuilder.github.io
Author: Alexander Metzner, Maximilien Riehl, Michael Gruber, Udo Juettner, Marcel Wolf, Arcadiy Ivanov, Valentin Haenel
Author-email: alexander.metzner@gmail.com, max@riehl.io, aelgru@gmail.com, udo.juettner@gmail.com, marcel.wolf@me.com, arcadiy@ivanov.biz, valentin@haenel.co
License: Apache License
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: !=3.0,!=3.1,!=3.2,<3.7,>=2.6
Requires-Dist: pip (<11dev,>=7.1)
Requires-Dist: setuptools (~=39.0.0)
Requires-Dist: tailer
Requires-Dist: tblib
Requires-Dist: wheel (~=0.31)

PyBuilder
=========

`PyBuilder <http://pybuilder.github.io>`__

|Build Status| |Windows build status| |PyPI version| |Coverage Status|
|Ready in backlog| |Open bugs|

PyBuilder is a software build tool written in 100% pure Python, mainly
targeting Python applications.

PyBuilder is based on the concept of dependency based programming, but
it also comes with a powerful plugin mechanism, allowing the
construction of build life cycles similar to those known from other
famous (Java) build tools.

PyBuilder is running on the following versions of Python: 2.6, 2.7, 3.3,
3.4, 3.5 and PyPy.

See the `Travis Build <https://travis-ci.org/pybuilder/pybuilder>`__ for
version specific output.

Installing
----------

PyBuilder is available using pip:

::

    $ pip install pybuilder

For development builds use:

::

    $ pip install --pre pybuilder 

See the `Cheeseshop
page <https://warehouse.python.org/project/pybuilder/>`__ for more
information.

Getting started
---------------

PyBuilder emphasizes simplicity. If you want to build a pure Python
project and use the recommended directory layout, all you have to do is
create a file build.py with the following content:

.. code:: python

    from pybuilder.core import use_plugin

    use_plugin("python.core")
    use_plugin("python.unittest")
    use_plugin("python.coverage")
    use_plugin("python.distutils")

    default_task = "publish"

See the `PyBuilder homepage <http://pybuilder.github.com/>`__ for more
details.

Plugins
-------

PyBuilder provides a lot of plugins out of the box that utilize tools
and libraries commonly used in Python projects:

-  `python.coverage <http://pybuilder.github.com/documentation/plugins.html#Measuringunittestcoverage>`__
   - Uses the standard
   `coverage <https://warehouse.python.org/project/coverage/>`__ module
   to calculate unit test line coverage.
-  `python.distutils <http://pybuilder.github.com/documentation/plugins.html#BuildingaPythonpackage>`__
   - Provides support to generate and use
   `setup.py <https://warehouse.python.org/project/setuptools/>`__
   files.
-  **python.django** - Provides support for developing
   `Django <https://www.djangoproject.com/>`__ applications.
-  `python.frosted <http://pybuilder.github.io/documentation/plugins.html#Frostedplugin>`__
   - Lint source files with
   `frosted <https://github.com/timothycrosley/frosted>`__
-  `python.flake8 <http://pybuilder.github.io/documentation/plugins.html#Flake8plugin>`__
   - Provides support for
   `flake8 <https://warehouse.python.org/project/flake8/>`__
-  `python.pep8 <http://pybuilder.github.io/documentation/plugins.html#Pep8plugin>`__
   - Provides support for
   `pep8 <https://warehouse.python.org/project/pep8/>`__
-  `python.install\_dependencies <http://pybuilder.github.io/documentation/plugins.html#Installingdependencies>`__
   - Installs the projects build and runtime dependencies using ``pip``
-  `python.pychecker <http://pybuilder.github.io/documentation/plugins.html#Pycheckerplugin>`__
   - Provides support for
   `pychecker <http://pychecker.sourceforge.net/>`__
-  `python.Pydev <http://pybuilder.github.io/documentation/plugins.html#ProjectfilesforEclipsePyDev>`__
   - Generates project files to import projects into `Eclipse
   PyDev <http://pydev.org/>`__
-  `python.PyCharm <http://pybuilder.github.io/documentation/plugins.html#ProjectfilesforJetbrainsPyCharm>`__
   - Generates project files to import projects into `Jetbrains
   PyCharm <http://www.jetbrains.com/pycharm/>`__
-  `python.pylint <http://pybuilder.github.io/documentation/plugins.html#Pylintplugin>`__
   - Executes `pylint <https://bitbucket.org/logilab/pylint/>`__ on your
   sources.
-  `python.pymetrics <http://pybuilder.github.io/documentation/plugins.html#Pymetricsplugin>`__
   - Calculates several metrics using
   `pymetrics <http://sourceforge.net/projects/pymetrics/>`__
-  `python.unittest <http://pybuilder.github.com/documentation/plugins.html#RunningPythonUnittests>`__
   - Executes
   `unittest <http://docs.python.org/library/unittest.html>`__ test
   cases
-  `python.integrationtest <http://pybuilder.github.com/documentation/plugins.html#RunningPythonIntegrationTests>`__
   - Executes python scripts as integrations tests
-  `python.pytddmon <http://pybuilder.github.io/documentation/plugins.html#Visualfeedbackfortests>`__
   - Provides visual feedback about unit tests through
   `pytddmon <http://pytddmon.org/>`__
-  `python.cram <http://pybuilder.github.io/documentation/plugins.html#RunningCramtests>`__
   - Runs `cram <https://warehouse.python.org/project/cram/>`__ tests
-  `python.sphinx <http://pybuilder.github.io/documentation/plugins.html#Creatingdocumentationwithsphinx>`__
   - Build your documentation with `sphinx <http://sphinx-doc.org/>`__
-  `python.sonarqube <http://pybuilder.github.io/documentation/plugins.html#SonarQubeintegration>`__
   - Analyze your project with
   `SonarQube <http://www.sonarqube.org/>`__.
-  python.snakefood - Analyze your code dependencies with
   `snakefood <https://bitbucket.org/blais/snakefood>`__.

In addition, a few common plugins are provided:

-  `copy\_resources <http://pybuilder.github.io/documentation/plugins.html#Copyingresourcesintoadistribution>`__
   - Copies files.
-  `filter\_resources <http://pybuilder.github.io/documentation/plugins.html#Filteringfiles>`__
   - Filters files by replacing tokens with configuration values.
-  `source\_distribution <http://pybuilder.github.io/documentation/plugins.html#Creatingasourcedistribution>`__
   - Bundles a source distribution for shipping.

External plugins: \*
`pybuilder\_aws\_plugin <https://github.com/immobilienscout24/pybuilder_aws_plugin>`__
- handle AWS functionality

Release Notes
-------------

The release notes can be found
`here <http://pybuilder.github.com/releasenotes/>`__. There will also be
a git tag with each release. Please note that we do not currently
promote tags to GitHub "releases".

Development
-----------

See `developing
PyBuilder <http://pybuilder.github.io/documentation/developing_pybuilder.html>`__

.. |Build Status| image:: https://secure.travis-ci.org/pybuilder/pybuilder.png?branch=master
   :target: http://travis-ci.org/pybuilder/pybuilder
.. |Windows build status| image:: https://ci.appveyor.com/api/projects/status/5jhel32oppeoqmw6/branch/0.11?svg=true
   :target: https://ci.appveyor.com/project/arcivanov/pybuilder-yl8px/branch/0.11
.. |PyPI version| image:: https://badge.fury.io/py/pybuilder.png
   :target: https://warehouse.python.org/project/pybuilder/
.. |Coverage Status| image:: https://coveralls.io/repos/pybuilder/pybuilder/badge.png?branch=master
   :target: https://coveralls.io/r/pybuilder/pybuilder?branch=master
.. |Ready in backlog| image:: https://badge.waffle.io/pybuilder/pybuilder.png?label=ready&title=Ready
   :target: https://waffle.io/pybuilder/pybuilder
.. |Open bugs| image:: https://badge.waffle.io/pybuilder/pybuilder.png?label=bug&title=Open%20Bugs
   :target: https://waffle.io/pybuilder/pybuilder


