Cookiecutter Template for new Oslo libraries
2204e2dd14
Change-Id: I87fd248858923753f708709b62833bfefd67506e |
||
---|---|---|
oslo.{{cookiecutter.module_name}} | ||
tools | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
CONTRIBUTING.rst | ||
cookiecutter.json | ||
README.rst | ||
tox.ini |
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