TEMPLATE_PyPROJECT

About

.. todo:: write about

The latest documentation can be found online at http://packages.python.org/TEMPLATE_PyPROJECT.

Requirements

See: RequiredSoftware in documentation or:

{SOURCE}/docs/RequiredSoftware.rst

Installation

1. To install from pypi using pip/pip3:

   $ pip3 install TEMPLATE_PyPROJECT
   

2. To install from the source:

   $ python3 setup.py install
   

Building the Documentation

If you wish to generate your own copy of the documentation, you will need to:

1. Get the TEMPLATE_PyPROJECT source.

2. If not already installed - install PSphinxTheme

   $ pip3 install PSphinxTheme
   

3. From the TEMPLATE_PyPROJECT source directory, run python3 setup.py build_sphinx -E.

4. Once Sphinx is finished, point a web browser to the file:

   {SOURCE}/build/sphinx/html/index.html
   

Online Resources

• Docs: http://packages.python.org/TEMPLATE_PyPROJECT
• PyPI: http://pypi.python.org/pypi/TEMPLATE_PyPROJECT
• Source: https://github.com/peter1000/TEMPLATE_PyPROJECT

Projects using TEMPLATE_PyPROJECT

projects which make use of: TEMPLATE_PyPROJECT

TEMPLATE_PyPROJECT is distributed under the terms of the BSD 3-clause license. Consult LICENSE or BSD-3-Clause.

(c) 2014, peter1000 https://github.com/peter1000 All rights reserved.