Cookiecutter Template for new OpenStack projects
Go to file
Masayuki Igawa dabf93f528
Update URLs
This commit updates some URLs. All of our docs.openstack.org supports
HTTPS already. And, some of the URLs are outdated.

Change-Id: I49056e5bd196e5cca2faaa8f5bc34b56c89ff675
2019-09-04 22:47:15 +09:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10:00
{{cookiecutter.repo_name}} Update URLs 2019-09-04 22:47:15 +09:00
.gitignore Clean up .gitignore references to personal tools 2018-08-16 15:13:50 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:40:16 +00:00
CONTRIBUTING.rst Update URLs 2019-09-04 22:47:15 +09:00
README.rst Update URLs 2019-09-04 22:47:15 +09: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://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