Cookiecutter Template for new Oslo libraries
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ben Nemec 6a73ff4ddd Use recommended configuration for apidoc 1 month ago
oslo.{{cookiecutter.module_name}} Use recommended configuration for apidoc 1 month ago
tools Switch cookiecutter tox job to use test_tox_targets.sh 1 month ago
.gitignore Clean up .gitignore references to personal tools 9 months ago
.gitreview OpenDev Migration Patch 3 months ago
.zuul.yaml Move tox job in-tree 1 year ago
CONTRIBUTING.rst Improve CONTRIBUTING.rst for clarity 4 years ago
README.rst Remove git.openstack.org references 1 month ago
cookiecutter.json Update for use with oslo libraries 5 years ago
tox.ini Switch cookiecutter tox job to use test_tox_targets.sh 1 month ago

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