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.
 
 
 

1.4 KiB

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 3.7
  • Sphinx docs: Documentation ready for generation and publication

Usage

Install cookiecutter:

pip install cookiecutter

Generate a Python package project:

cookiecutter https://opendev.org/openstack/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