openstack
/
cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new OpenStack projects
177 Commits 1 Branch 0 Tags 975 KiB
Python 99.4%
Shell 0.6%
Go to file
Jeremy Stanley da86f5e042 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).

Change-Id: Ib58a57267b064e4142686de6c37a70dbff04b9a7
 		2018-08-16 15:13:50 +00:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10:00
{{cookiecutter.repo_name}} Clean up .gitignore references to personal tools 2018-08-16 15:13:50 +00:00
.gitignore Clean up .gitignore references to personal tools 2018-08-16 15:13:50 +00:00
.gitreview Add .gitreview file 2013-08-18 15:42:02 -04:00
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 2015-05-16 12:20:49 +00:00
README.rst Merge "Switch to use stestr in README" 2018-01-08 14:48:40 +00:00
cookiecutter.json Fixed two issues regarding cookiecutter template 2018-06-02 13:42:46 +02:00

README.rst

cookiecutter-openstack

Cookiecutter template for an 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
  • stestr: Runs tests using stestr
  • OpenStack-Infra: Ready for OpenStack Continuous Integration testing
  • Tox testing: Setup to easily test for Python 2.7, 3.5
  • Sphinx docs: Documentation ready for generation and publication

Usage

Install cookiecutter:

pip install cookiecutter

Generate a Python package project:

cookiecutter https://git.openstack.org/openstack-dev/cookiecutter.git

OpenStack projects require a working git repo for pbr to work, on newer versions of cookiecutter (>= 0.7.0 released 2013-11-09) this initial commit will be done automatically. Otherwise you will need to init a repo and commit to it before doing anything else:

cd $repo_name
git init
git add .
git commit -a

Then:

  • Add the project to the OpenStack Infrastructure