Cookiecutter Template for new Oslo libraries
Go to file
Jeremy Stanley 29a3bae7ac Clean up .gitignore references to personal tools
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
2018-10-05 17:43:14 +00:00
oslo.{{cookiecutter.module_name}} Clean up .gitignore references to personal tools 2018-10-05 17:43:14 +00:00
tools Add test script 2014-07-28 09:49:24 -04:00
.gitignore Clean up .gitignore references to personal tools 2018-10-05 17:43:14 +00:00
.gitreview Fix .gitreview and use of oslosphinx 2014-02-18 08:47:29 -05:00
.zuul.yaml Move tox job in-tree 2018-01-28 11:44:33 +01:00
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 2015-05-16 13:15:50 +00:00
README.rst Replace ci.o.o links with docs.o.o/infra 2015-05-14 21:38:16 +00:00
cookiecutter.json Update for use with oslo libraries 2014-01-31 15:22:08 -08:00
tox.ini Add test script 2014-07-28 09:49:24 -04:00

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