Cookiecutter Template for new OpenStack projects
d13ff9ac8b
Yoga testing runtime[1] has been updated to add py39 testing as voting. Unit tests update are handled by the job template change in openstack-zuul-job - https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/820286 this commit updates the classifier in setup.cfg file. [1] https://governance.openstack.org/tc/reference/runtimes/yoga.html Change-Id: I4f03a44bc5da0e16b4b1835a69cb22faa9c89f6d |
||
---|---|---|
{{cookiecutter.repo_name}} | ||
hooks | ||
releasenotes/notes | ||
.gitignore | ||
.gitreview | ||
CONTRIBUTING.rst | ||
cookiecutter.json | ||
README.rst |
cookiecutter-openstack
Cookiecutter template for an 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
- stestr: Runs tests using stestr
- OpenStack-Infra: Ready for OpenStack Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.7
- Sphinx docs: Documentation ready for generation and publication
Usage
Install cookiecutter:
pip install cookiecutter
Generate a Python package project:
cookiecutter https://opendev.org/openstack/cookiecutter.git
OpenStack projects require a working git repo for pbr to work, on newer versions of cookiecutter (>= 0.7.0 released 2013-11-09) this initial commit will be done automatically. Otherwise you will need to init a repo and commit to it before doing anything else:
cd $repo_name
git init
git add .
git commit -a
Then:
- Add the project to the OpenStack Infrastructure