Metadata-Version: 2.1
Name: templatekit
Version: 0.1.1rc2
Summary: Tookit for rendering LSST project templates.
Home-page: https://github.com/lsst-sqre/templatekit
Author: Association of Universities for Research in Astronomy
Author-email: sqre-admin@lists.lsst.org
License: MIT
Keywords: lsst,cookiecutter
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: cookiecutter (<2.0.0,>=1.6.0)
Requires-Dist: Jinja2 (<3.0.0,>=2.10)
Requires-Dist: scons (<3.1.0,>=3.0.1)
Requires-Dist: click (<7.0,>=6.7)
Requires-Dist: pyperclip (<1.7.0,>=1.6.0)
Provides-Extra: dev
Requires-Dist: pytest (==4.0.2) ; extra == 'dev'
Requires-Dist: pytest-flake8 (==1.0.2) ; extra == 'dev'
Requires-Dist: cookiecutter (<2.0.0,>=1.6.0) ; extra == 'dev'
Requires-Dist: Jinja2 (<3.0.0,>=2.10) ; extra == 'dev'
Requires-Dist: scons (<3.1.0,>=3.0.1) ; extra == 'dev'
Requires-Dist: click (<7.0,>=6.7) ; extra == 'dev'
Requires-Dist: pyperclip (<1.7.0,>=1.6.0) ; extra == 'dev'
Requires-Dist: documenteer[pipelines] (<0.5.0,>=0.4.0) ; extra == 'dev'
Requires-Dist: sphinx-click (<1.3.0,>=1.2.0) ; extra == 'dev'

###########
Templatekit
###########

Templatekit is a Python library and command-line app for using and maintaining a centralized repository of project and file templates.
Templates are built with Cookiecutter_ and Jinja_.
https://github.com/lsst/templates is the primary repository that Templatekit is built for, but Templatekit can be used for other template repository projects.

Development
===========

Clone Templatekit with test data (`lsst/templates`_)::

   git clone --recursive-submodules https://github.com/lsst-sqre/templatekit

Install the package for development (do this in a `virtual environment`_)::

   cd templatekit
   pip install -e ".[dev]"

Run tests::

   pytest

You can also run tests without installing Templatekit first::

   python setup.py test

Occasionally you may need to update the ``tests/data/templates`` submodule::

   git submodule update --recursive

.. _Cookiecutter: https://cookiecutter.readthedocs.io/en/latest/
.. _Jinja: http://jinja.pocoo.org
.. _lsst/templates: https://github.com/lsst/templates
.. _virtual environment: https://docs.python.org/3/library/venv.html


