openstack
/
cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new OpenStack projects
158 Commits 1 Branch 0 Tags 975 KiB
Python 99.4%
Shell 0.6%
Go to file
Andreas Jaeger b52e5f2f14 Update for openstackdocstheme 1.11 
Update for most recent openstackdocstheme, use it for releasenotes as
well.

Change-Id: I0a04bb69553c30f23091444ef893f854bbf6e857
 		2017-06-29 11:53:09 +02:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10:00
{{cookiecutter.repo_name}} Update for openstackdocstheme 1.11 2017-06-29 11:53:09 +02: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 Usage: install cookiecutter firstly 2017-05-23 11:21:53 +08:00
cookiecutter.json Add src and bug links to README 2014-02-24 08:28:41 -08: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
  • testrepository: Runs tests using testrepository
  • 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 inital 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