Metadata-Version: 2.0
Name: PythonTemplateDemo
Version: 0.0.0
Summary: PythonTemplateDemo is a Python 3 package template.
Home-page: https://github.com/jacebrowning/template-python-demo
Author: Jace Browning
Author-email: jacebrowning@gmail.com
License: WTFPL
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.3
Requires-Dist: testpackage (==2.26)
Requires-Dist: newrelic-plugin-agent (==1.3.0)

PythonTemplateDemo
==================

A sample project templated from jacebrowning/template-python.

| |Build Status|
| |Coverage Status|
| |Scrutinizer Code Quality|
| |PyPI Version|
| |PyPI Downloads|

Getting Started
===============

Requirements
------------

-  Python 2.7+ or Python 3.3+

Installation
------------

PythonTemplateDemo can be installed with pip:

::

    $ pip install PythonTemplateDemo

or directly from the source code:

::

    $ git clone https://github.com/jacebrowning/template-python-demo.git
    $ cd template-python-demo
    $ python setup.py install

Basic Usage
===========

After installation, abstract base classes can be imported from the
package:

::

    $ python
    >>> import demo
    demo.__version__

PythonTemplateDemo doesn't do anything, it's a template.

For Contributors
================

Requirements
------------

-  GNU Make:

   -  Windows: http://cygwin.com/install.html
   -  Mac: https://developer.apple.com/xcode
   -  Linux: http://www.gnu.org/software/make (likely already installed)

-  virtualenv: https://pypi.python.org/pypi/virtualenv#installation
-  Pandoc: http://johnmacfarlane.net/pandoc/installing.html
-  Graphviz: http://www.graphviz.org/Download.php

Installation
------------

Create a virtualenv:

::

    $ make env

Run the tests:

::

    $ make test
    $ make tests  # includes integration tests

Build the documentation:

::

    $ make doc

Run static analysis:

::

    $ make pep8
    $ make pep257
    $ make pylint
    $ make check  # includes all checks

Prepare a release:

::

    $ make dist  # dry run
    $ make upload

.. |Build Status| image:: http://img.shields.io/travis/jacebrowning/template-python-demo/master.svg
   :target: https://travis-ci.org/jacebrowning/template-python-demo
.. |Coverage Status| image:: http://img.shields.io/coveralls/jacebrowning/template-python-demo/master.svg
   :target: https://coveralls.io/r/jacebrowning/template-python-demo
.. |Scrutinizer Code Quality| image:: http://img.shields.io/scrutinizer/g/jacebrowning/template-python-demo.svg
   :target: https://scrutinizer-ci.com/g/jacebrowning/template-python-demo/?branch=master
.. |PyPI Version| image:: http://img.shields.io/pypi/v/PythonTemplateDemo.svg
   :target: https://pypi.python.org/pypi/PythonTemplateDemo
.. |PyPI Downloads| image:: http://img.shields.io/pypi/dm/PythonTemplateDemo.svg
   :target: https://pypi.python.org/pypi/PythonTemplateDemo

Changelog
=========

0.0.0 (2013/10/09)
------------------

 - <Change the version, date, and this text.>


