openstack
/
cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new OpenStack projects
168 Commits 1 Branch 0 Tags 975 KiB
Python 99.4%
Shell 0.6%
Go to file
Masayuki Igawa 006a866691
Switch to use stestr in README 
This commit fixes to use stestr and one typo in README.rst.

Change-Id: Ie4ff7b64631548ff36edef35756b9e9ab259a687
 		2017-12-25 14:17:45 +09:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10:00
{{cookiecutter.repo_name}} Merge "Fix docs.o.o URLs" 2017-10-19 10:45:05 +00:00
.gitignore Ignore .eggs cruft 2015-06-17 01:01:15 +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 Switch to use stestr in README 2017-12-25 14:17:45 +09:00
cookiecutter.json Update to the Pike document structure 2017-07-11 12:37:40 +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.6, 2.7, 3.3, 3.4
  • 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