Cookiecutter Template for new OpenStack projects
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 97446fb5bb OpenDev Migration Patch 4 weeks ago
hooks Automatically initialize git when finished. 4 years ago
{{cookiecutter.repo_name}} Update contact address to openstack-discuss ML 5 months ago
.gitignore Clean up .gitignore references to personal tools 9 months ago
.gitreview OpenDev Migration Patch 4 weeks ago
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 4 years ago
README.rst Update the outdated URL in README.rst 7 months ago
cookiecutter.json Fixed two issues regarding cookiecutter template 11 months ago

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