openstack/cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new OpenStack projects
147 Commits 1 Branch 0 Tags 975 KiB
Python 99.4%
Shell 0.6%
f619226d34
Go to file
Jim Rollenhagen f619226d34 Use launchpad_project in CONTRIBUTING.rst 
This template has an option for launchpad project, but it is not used in
CONTRIBUTING.rst. Fix that.

Change-Id: I60d9b79eea7d9ad57b26bdc24f8cb02d3f2a1ccd
2016-11-18 06:33:40 -05:00
{{cookiecutter.repo_name}} Use launchpad_project in CONTRIBUTING.rst 2016-11-18 06:33:40 -05:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10: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
cookiecutter.json Add src and bug links to README 2014-02-24 08:28:41 -08:00
README.rst Replace ci.o.o links with docs.o.o/infra 2015-05-14 21:38:16 +00: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

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