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 template for projects
4 commits 1 branch 0 tags 44 KiB
Python 100%
Find a file
Gavin M. Roy 5bb05e461d 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 22:09:21 -04:00
sprockets.{{cookiecutter.project_name}} Updates to many things 2014-08-28 22:09:21 -04:00
cookiecutter.json Updates to many things 2014-08-28 22:09:21 -04:00
README.rst Update README.rst 2014-08-20 08:04:15 -04:00

README.rst 

Sprockets Package Template
==========================

This is a cookiecutter_ template that generates a sprockets package that
is consistent with the rest of the eco-system and ready to go in a few
seconds.  You will need to install the cookiecutter_ utility, then point
it at this repository, answer a few questions, and start coding::

   $ cookiecutter https://github.com/sprockets/cookiecutter-sprockets
   project_name (default is "")? packagename
   full_name (default is "")? John Doe
   email (default is "")? john.doe@example.com
   description (default is "")? This goes into setup.py
   git_org (default is "sprockets")?
   year (default is "2014")?
   $ cd sprockets.packagename
   $ ls
   .travis.yml             dev-requirements.txt    setup.py
   LICENSE                 doc/                    sprockets/
   MANIFEST.in             requirements.txt        test-requirements.txt
   README.rst              setup.cfg               tests/

As you can see, there are a handful of files there for you already.

.. _cookiecutter:: http://cookiecutter.readthedocs.org/en/latest/index.html