29a3bae7ac
Developers run all sorts of different tools within Git repositories, any of which can leave their own special trashfiles all over the place. We can't every hope to catalog them all, so better to recommend developers simply configure a global core.excludesfile to filter the irrelevant files which tend to get created by their personal choice of tools. To this end, remove the long-standing sections for "Mr Developer" and "Editors" since their mere existence here sends the signal that we welcome (and have time to review) additions for any old tool someone ever might happen to try. Also add a comment block explaining this, for clarity. We can, and should of course, continue to list files created by the tools recommended by our workflow (test frameworks called from tox, documentation and packaging builds, et cetera). This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7 from the openstack-dev/cookiecutter repository. Change-Id: I1b41efac219fca44e2548fc36633724d0ecfc0cb |
||
---|---|---|
oslo.{{cookiecutter.module_name}} | ||
tools | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
CONTRIBUTING.rst | ||
README.rst | ||
cookiecutter.json | ||
tox.ini |
README.rst
oslo-cookiecutter-openstack
Cookiecutter template for an Oslo library (part of the OpenStack project). See https://github.com/audreyr/cookiecutter.
- Free software: Apache license
- pbr: Set up to use Python Build Reasonableness
- hacking: Enforces the OpenStack Hacking Guidelines
- testrepository: Runs tests using testrepository
- OpenStack-Infra: Ready for OpenStack Continuous Integration testing
- Tox testing: Setup to easily test for Python 2.6, 2.7, 3.3, 3.4
- Sphinx docs: Documentation ready for generation and publication
Usage
Generate a Python package project:
cookiecutter https://git.openstack.org/openstack-dev/oslo-cookiecutter.git
Oslo libraries require a working git repo for pbr to work, so you need to init a repo and commit to it before doing anything else:
cd oslo.$module_name
git init
git add .
git commit -a
Then:
- Add the project to the OpenStack Infrastructure