openstack
/
oslo-cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new Oslo libraries
151 Commits 1 Branch 0 Tags 703 KiB
Python 83.4%
Shell 16.6%
Go to file
Ben Nemec 415ee2362d Move doc requirements to doc/requirements.txt 
This is the standard way to handle doc requirements now.

Change-Id: I2487e70168566506df3c34687ca4cfa1bdd2ef4a
 		2019-05-31 17:18:28 +00:00
oslo.{{cookiecutter.module_name}} Move doc requirements to doc/requirements.txt 2019-05-31 17:18:28 +00:00
tools Fix cookiecutter tox tests in gate 2019-05-31 17:18:28 +00:00
.gitignore Clean up .gitignore references to personal tools 2018-10-05 17:43:14 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:48:28 +00:00
.zuul.yaml Move tox job in-tree 2018-01-28 11:44:33 +01:00
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 2015-05-16 13:15:50 +00:00
README.rst Replace ci.o.o links with docs.o.o/infra 2015-05-14 21:38:16 +00:00
cookiecutter.json Update for use with oslo libraries 2014-01-31 15:22:08 -08:00
tox.ini Update min tox version to 2.0 2018-11-02 07:46:50 +00: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, 3.4
  • 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