openstack
/
oslo-cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new Oslo libraries
93 Commits 1 Branch 0 Tags 703 KiB
Python 83.4%
Shell 16.6%
Go to file
Yuriy Taraday 7f5f759f19 Add common fixes for docs generation to template 
Change-Id: Ieea0dc7ed7218e9bf5626e174e6184901efd9761
 		2014-08-16 01:30:29 +04:00
oslo.{{cookiecutter.module_name}} Add common fixes for docs generation to template 2014-08-16 01:30:29 +04:00
tools Add test script 2014-07-28 09:49:24 -04:00
.gitignore Ignore created boilerplate/ dir. 2013-08-16 20:59:16 +02:00
.gitreview Fix .gitreview and use of oslosphinx 2014-02-18 08:47:29 -05:00
CONTRIBUTING.rst Add a CONTRIBUTING file with bug tracker info 2013-09-20 16:44:41 -07:00
README.rst Update for use with oslo libraries 2014-01-31 15:22:08 -08:00
cookiecutter.json Update for use with oslo libraries 2014-01-31 15:22:08 -08:00
openstack-common.conf Sync cross-test script 2014-03-27 12:46:09 -07:00
tox.ini Add test script 2014-07-28 09:49:24 -04:00

README.rst

oslo-cookiecutter-openstack

Cookiecutter template for an Oslo library (part of the 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
  • Sphinx docs: Documentation ready for generation and publication

Usage

Generate a Python package project:

cookiecutter https://git.openstack.org/openstack-dev/oslo-cookiecutter.git

Oslo libraries 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 oslo.$module_name
git init
git add .
git commit -a

Then:

  • Add the project to the OpenStack Infrastructure