specs-cookiecutter/README.rst
2014-03-24 14:46:13 -04:00

985 B

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
  • OpenStack-Infra: Ready for OpenStack Continuous Integration testing
  • Tox testing: Setup to easily building sphunx docs
  • Sphinx docs: Documentation ready for generation and publication

Usage

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, so you 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