Cookiecutter Template for new Oslo libraries
Go to file
Hervé Beraud 2204e2dd14 sync oslo-cookiecutter contributing template
Change-Id: I87fd248858923753f708709b62833bfefd67506e
2020-08-10 15:18:39 +00:00
oslo.{{cookiecutter.module_name}} sync oslo-cookiecutter contributing template 2020-08-10 15:18:39 +00:00
tools trivial: refresh template with recent best practices 2020-04-01 13:56:26 +02: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 Add ensure-tox support. 2020-08-07 15:49:55 +02:00
CONTRIBUTING.rst sync oslo-cookiecutter contributing template 2020-08-10 15:18:39 +00:00
README.rst Remove git.openstack.org references 2019-05-31 17:59:08 +00:00
cookiecutter.json Update for use with oslo libraries 2014-01-31 15:22:08 -08:00
tox.ini [ussuri][goal] Drop python 2.7 support and testing 2020-02-03 19:55:04 +01: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://opendev.org/openstack/oslo-cookiecutter

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