Metadata-Version: 1.1
Name: pyscaffold
Version: 0.5
Summary: Tool for easily putting up the scaffold of a Python project
Home-page: https://github.com/blue-yonder/pyscaffold
Author: Florian Wilhelm
Author-email: Florian.Wilhelm@blue-yonder.com
License: new BSD
Description: ==========
        PyScaffold
        ==========
        
        .. image:: https://travis-ci.org/blue-yonder/pyscaffold.svg?branch=master
            :target: https://travis-ci.org/blue-yonder/pyscaffold
        .. image:: https://coveralls.io/repos/blue-yonder/pyscaffold/badge.png
            :target: https://coveralls.io/r/blue-yonder/pyscaffold
        
        PyScaffold helps you to easily setup a new Python project, it is as easy as::
        
            putup my_project
            
        This will create a new subdirectory ``my_project`` and serve you a project
        setup with git repository, setup.py, document and test folder ready for some
        serious coding.
        
        Type ``putup -h`` to learn about more configuration options. PyScaffold assumes 
        that you have `Git  <http://git-scm.com/>`_ installed and set up on your PC, 
        meaning at least your name and email configured.
        The scaffold of ``my_project`` provides you with following features:
        
        Packaging
        =========
        
        Run ``python setup.py sdist``, ``python setup.py bdist`` or
        ``python setup.py bdist_wheel`` to build a source, binary or wheel
        distribution.
        
        
        Complete Git Integration
        ========================
        
        Your project is already an initialised Git repository and ``setup.py`` uses
        the information of tags to infer the version of your project with the help of
        `versioneer <https://github.com/warner/python-versioneer>`_.
        To use this feature you need to tag with the format ``vMAJOR.MINOR.REVISION``,
        e.g. ``v0.0.1`` or ``v0.1``. The prefix ``v`` is needed!
        Run ``python setup.py version`` to retrieve the current `PEP440
        <http://www.python.org/dev/peps/pep-0440/>`_-compliant version. This version
        will be used when building a package and is also accessible through
        ``my_project.__version__``.
        The version will be ``unknown`` until you have added a first tag.
        
        
        Sphinx Documentation
        ====================
        
        Build the documentation with ``python setup.py docs`` and run doctests with
        ``python setup.py doctest``. Start editing the file ``docs/index.rst`` to
        extend the documentation.
        
        
        Unittest & Coverage
        ===================
        
        Run ``python setup.py test`` to run all unittests defined in the subfolder
        ``tests`` with the help of `py.test <http://pytest.org/>`_. The py.test plugin
        `pytest-cov <https://github.com/schlamar/pytest-cov>`_ is used to automatically
        generate a coverage report.
        
        
        Requirements Management
        =======================
        
        Add the requirements of your project to the ``requirements.txt`` file which
        will be automatically used by ``setup.py``.
        
        
        Easy Updating
        =============
        
        Keep your project's scaffold up-to-date by applying
        ``putput --update my_project`` when a new version of PyScaffold was released.
        It may also be used to change the url, license and description setting.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Utilities
