Metadata-Version: 1.0
Name: modern-package-template
Version: 1.0
Summary: PasteScript template to create a Python project with distribute and buildout support
Home-page: http://bitbucket.org/srid/modern-package-template/
Author: Sridhar Ratnakumar
Author-email: srid@nearfar.org
License: GNU General Public License v3
Description: modern-package-template
        =======================
        
        modern-package-template is a `PasteScript template`_ to create an initial layout
        for your Python projects using modern tools and practices followed in the Python
        community. Thus, your projects will have the following characteristics:
        
        1. Use Distribute_ instead of setuptools as the BDFL himself supports_ it.
        2. Buildout_ support, though you are not required to make use of it.
        3. ``README.txt`` and ``NEWS.txt`` automatically included in your package
           metadata as ``long_description``, thus making them appear in the PyPI_ page
           for your project.
        4. Automatic script (or .exe) creation using Distribute
        
        Here is `a sample project`_ created using modern-package-template.
        
        See the section titled "Roadmap" below for planned features.
        
        .. _PyPI: http://pypi.python.org/
        .. _Buildout: http://www.buildout.org/
        .. _supports: http://mail.python.org/pipermail/python-dev/2009-October/092678.html
        .. _Distribute: http://packages.python.org/distribute/
        .. _`PasteScript template`: http://pythonpaste.org/script/developer.html#templates
        .. _`a sample project`: http://bitbucket.org/srid/mpt-sample/src/
        
        
        Getting started
        ---------------
        
        First install modern-package-template using PyPM_ or pip_:
        
        ::
        
            $ pypm install modern-package-template
            
            OR
            
            $ pip install modern-package-template
            
        .. _PyPM: http://pypm.activestate.com/
        .. _pip: http://pip.openplans.org/
        
        
        To create a Python project called "helloworld", run the following command in
        your terminal:
            
        ::
        
            $ paster create -t modern_package helloworld
        
        You can also, optionally, create `namespace packages`_:
        
        ::
        
            $ paster create -t modern_package my.new.package package=my.new.package
            
        .. _`namespace packages`: http://packages.python.org/distribute/setuptools.html#namespace-packages
            
        Once you create the project layout, the very first thing you must do is to
        review the contents of ``README.txt`` and edit it accordingly.
            
        Roadmap
        -------
        
        In the next release, I'd like to add support for Sphinx and Sphinx-PyPI-upload
        tool, so that developers can upload their sphinx-based documentation to
        packages.python.org without having to manually do it themselves.
        
        If you like, please help with working on one of the `new/open issues`_.
        
        .. _`new/open issues`: http://bitbucket.org/srid/modern-package-template/issues/?status=new&status=open
            
        Credits
        -------
        
        Source code is derived from the `advanced_package`_ template - which is also
        licensed under GPLv3.
        
        .. _advanced_package: http://pypi.python.org/pypi/harobed.paster_template.advanced_package/
        
        News
        ====
        
        1.0
        ---
        
        *Release date: 11-Apr-2010*
        
        - #20: Include .gitignore
        - #19: Rename README.txt to README.rst so it renders on Github
        
        
        1.0c2
        -----
        
        *Release date: 02-Apr-2010*
        
        - #18: Fix missing .hgignore
        
        
        1.0c1
        -----
        
        *Release date: 30-Mar-2010*
        
        - Add a 'Credits' section to README.txt
        - #2: Include a sample entry point
        - #13: Include .hgignore
        - #11: Include dev howtos in HACKING.txt 
        - Remove setup.cfg -- simple to have no .dev marker
        
        1.0b2
        -----
        
        *Release date: 15-Mar-2010*
        
        - #10: Remove dependency on Distribute
        - #9: Remove distribute_setup.py
        
        1.0b1
        -----
        
        *Release date: 14-Mar-2010*
        
        - #6: Remove zip_safe from the template questionnaire
        - #3: Add README.txt and NEWS.txt as a replacement for long_description
        - #1: Add distribute_setup.py to the template
        
        0.9.2
        -----
        
        *Release date: 14-Feb-2010*
        
        - Provide a complete buildout.cfg that is usable
        - Use buildout by default
        - Use Distribute instead of Setuptools
        - Inherit from harobed.paster_template.advanced_package 0.2
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Framework :: Paste
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Code Generators
