github/cookiecutter-sprockets
1
0
Fork 0
mirror of https://github.com/sprockets/cookiecutter-sprockets.git synced 2024-11-23 19:29:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
cookiecutter-sprockets/sprockets.{{cookiecutter.project_name}}/README.rst

51 lines
1.9 KiB
ReStructuredText
Raw Normal View History

Initial commit
2014-08-20 12:01:06 +00:00
sprockets.{{ cookiecutter.project_name }}
{{ '=' * (10 + cookiecutter.project_name|length) }}
Updates to many things - Documentation updates, fleshing out more of the baseline expectations - README.rst updates with the baseline expectations - Remove tornado from the requirements.txt - Update the nosetests configuration in setup.cfg - Remove unneeded 2.6 requirements - Update classifiers - Update name in cookiecutter.json - Use manual package names in packages - Mark as non-zip safe - Remove tests directory - Make default tests.py file - Explicitly add coverage to the test requirements - Add README.rst to MANIFEST.in - Update Trove classifiers - Ensure setup.py will include README.rst and LICENSE (dupe of MANIFEST.in) - Add test_suite to setup.py - Set default description in cookiecutter.json Additional refactoring - Change to be a sprockets.foo.bar project - Move doc to docs - Add additional documentation templates - Change version to only show major.minor - Add docs/Makefile - Minor README and docs updates Fix the travis file and readthedocs URLs Deployment/pypi related updates
2014-08-28 23:25:02 +00:00
{{ cookiecutter.description }}
Initial commit
2014-08-20 12:01:06 +00:00
Updates to many things - Documentation updates, fleshing out more of the baseline expectations - README.rst updates with the baseline expectations - Remove tornado from the requirements.txt - Update the nosetests configuration in setup.cfg - Remove unneeded 2.6 requirements - Update classifiers - Update name in cookiecutter.json - Use manual package names in packages - Mark as non-zip safe - Remove tests directory - Make default tests.py file - Explicitly add coverage to the test requirements - Add README.rst to MANIFEST.in - Update Trove classifiers - Ensure setup.py will include README.rst and LICENSE (dupe of MANIFEST.in) - Add test_suite to setup.py - Set default description in cookiecutter.json Additional refactoring - Change to be a sprockets.foo.bar project - Move doc to docs - Add additional documentation templates - Change version to only show major.minor - Add docs/Makefile - Minor README and docs updates Fix the travis file and readthedocs URLs Deployment/pypi related updates
2014-08-28 23:25:02 +00:00
|Version| |Downloads| |Status| |Coverage| |License|
Installation
------------
Fix travis testing for Python 2.6 and minor doc cleanup
2014-08-29 17:12:01 +00:00
``sprockets.{{ cookiecutter.project_name }}`` is available on the
Updates to many things - Documentation updates, fleshing out more of the baseline expectations - README.rst updates with the baseline expectations - Remove tornado from the requirements.txt - Update the nosetests configuration in setup.cfg - Remove unneeded 2.6 requirements - Update classifiers - Update name in cookiecutter.json - Use manual package names in packages - Mark as non-zip safe - Remove tests directory - Make default tests.py file - Explicitly add coverage to the test requirements - Add README.rst to MANIFEST.in - Update Trove classifiers - Ensure setup.py will include README.rst and LICENSE (dupe of MANIFEST.in) - Add test_suite to setup.py - Set default description in cookiecutter.json Additional refactoring - Change to be a sprockets.foo.bar project - Move doc to docs - Add additional documentation templates - Change version to only show major.minor - Add docs/Makefile - Minor README and docs updates Fix the travis file and readthedocs URLs Deployment/pypi related updates
2014-08-28 23:25:02 +00:00
`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
------------
- `sprockets <https://github.com/sprockets/sprockets>`_
Example
-------
Fix travis testing for Python 2.6 and minor doc cleanup
2014-08-29 17:12:01 +00:00
This examples demonstrates how to use ``sprockets.{{ cookiecutter.project_name }}`` by ...
Updates to many things - Documentation updates, fleshing out more of the baseline expectations - README.rst updates with the baseline expectations - Remove tornado from the requirements.txt - Update the nosetests configuration in setup.cfg - Remove unneeded 2.6 requirements - Update classifiers - Update name in cookiecutter.json - Use manual package names in packages - Mark as non-zip safe - Remove tests directory - Make default tests.py file - Explicitly add coverage to the test requirements - Add README.rst to MANIFEST.in - Update Trove classifiers - Ensure setup.py will include README.rst and LICENSE (dupe of MANIFEST.in) - Add test_suite to setup.py - Set default description in cookiecutter.json Additional refactoring - Change to be a sprockets.foo.bar project - Move doc to docs - Add additional documentation templates - Change version to only show major.minor - Add docs/Makefile - Minor README and docs updates Fix the travis file and readthedocs URLs Deployment/pypi related updates
2014-08-28 23:25:02 +00:00
.. code:: python
from sprockets import {{ cookiecutter.project_name }}
# Example here
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
Reference in a new issue Copy permalink