Cookiecutter Template for new OpenStack projects
Go to file
OpenDev Sysadmins 97446fb5bb OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:40:16 +00:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10:00
{{cookiecutter.repo_name}} Update contact address to openstack-discuss ML 2018-11-30 18:53:23 +00:00
.gitignore Clean up .gitignore references to personal tools 2018-08-16 15:13:50 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:40:16 +00:00
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 2015-05-16 12:20:49 +00:00
README.rst Update the outdated URL in README.rst 2018-09-23 17:18:03 +08: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