github/cookiecutter-sprockets
1
0
Fork 0
mirror of https://github.com/sprockets/cookiecutter-sprockets.git synced 2024-11-23 11:19:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
cookiecutter-sprockets/sprockets.{{cookiecutter.project_name}}
History
Gavin M. Roy 9b8049d8a5 Multiple updates 
- Speed up travis testing
- Fix typo in index.rst
- Add sprockets to requirements.txt
- Remove version importing in setup.py
2014-08-29 10:30:12 -04:00
..
docs Multiple updates 2014-08-29 10:30:12 -04:00
sprockets Updates to many things 2014-08-28 22:09:21 -04:00
.travis.yml Multiple updates 2014-08-29 10:30:12 -04:00
dev-requirements.txt Initial commit 2014-08-20 08:01:06 -04:00
LICENSE Updates to many things 2014-08-28 22:09:21 -04:00
MANIFEST.in Updates to many things 2014-08-28 22:09:21 -04:00
README.rst Fix the coveralls badge 2014-08-28 23:39:43 -04:00
requirements.txt Multiple updates 2014-08-29 10:30:12 -04:00
setup.cfg Updates to many things 2014-08-28 22:09:21 -04:00
setup.py Multiple updates 2014-08-29 10:30:12 -04:00
test-requirements.txt Updates to many things 2014-08-28 22:09:21 -04:00
tests.py Updates to many things 2014-08-28 22:09:21 -04:00

README.rst 

sprockets.{{ cookiecutter.project_name }}
{{ '=' * (10 + cookiecutter.project_name|length) }}
{{ cookiecutter.description }}

|Version| |Downloads| |Status| |Coverage| |License|

Installation
------------
sprockets.{{ cookiecutter.project_name }} is available on the
`Python Package Index <https://pypi.python.org/pypi/sprockets.{{ cookiecutter.project_name }}>`_
and can be installed via ``pip`` or ``easy_install``:

.. code:: bash

  pip install sprockets.{{ cookiecutter.project_name }}

Documentation
-------------
https://sprockets{{ cookiecutter.project_name.replace('.', '') }}.readthedocs.org

Requirements
------------
@TODO: Put full requirements list here, should match requirements.text
-  `sprockets <https://github.com/sprockets/sprockets>`_

Example
-------
This examples demonstrates how to use sprockets.{{ cookiecutter.project_name }} by ...
.. code:: python

    from sprockets import {{ cookiecutter.project_name }}

    # Example here

More complex examples and documentation are available at https://sprockets.{{ cookiecutter.project_name }}.readthedocs.org

Version History
---------------
Available at https://sprockets{{ cookiecutter.project_name.replace('.', '') }}.readthedocs.org/en/latest/history.html

.. |Version| image:: https://badge.fury.io/py/sprockets.{{ cookiecutter.project_name }}.svg?
   :target: http://badge.fury.io/py/sprockets.{{ cookiecutter.project_name }}

.. |Status| image:: https://travis-ci.org/sprockets/sprockets.{{ cookiecutter.project_name }}.svg?branch=master
   :target: https://travis-ci.org/sprockets/sprockets.{{ cookiecutter.project_name }}

.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.{{ cookiecutter.project_name }}.svg?
   :target: https://coveralls.io/r/sprockets/sprockets.{{ cookiecutter.project_name }}

.. |Downloads| image:: https://pypip.in/d/sprockets.{{ cookiecutter.project_name }}/badge.svg?
   :target: https://pypi.python.org/pypi/sprockets.{{ cookiecutter.project_name }}

.. |License| image:: https://pypip.in/license/sprockets.{{ cookiecutter.project_name }}/badge.svg?
   :target: https://sprockets{{ cookiecutter.project_name.replace('.', '') }}.readthedocs.org