openstack
/
cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new OpenStack projects
178 Commits 1 Branch 0 Tags 975 KiB
Python 99.4%
Shell 0.6%
Go to file
melissaml 638c080071 Update the outdated URL in README.rst 
Change-Id: I613b9d5f1ac3f599a38dc648daad70de9864460f
 		2018-09-23 17:18:03 +08: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 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