openstack
/
oslo-cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new Oslo libraries
173 Commits 1 Branch 0 Tags 703 KiB
Python 83.4%
Shell 16.6%
Go to file
Daniel Bengtsson db278b6103 Add ensure-tox support. 
Use ensure_global_symlinks from ensure-tox to fix the CI fail. We need
to do that, because when we install the new sub environment in the new
project the tox is not visible. With the ensure_global_symlinks we do a
symlink into /usr/local/bin path.

Co-authored-by: Bernard Cafarelli <bcafarel@redhat.com>

Change-Id: I575e42fe15f16d0bd51597a540a13c4e384ec096
 		2020-08-07 15:49:55 +02:00
oslo.{{cookiecutter.module_name}} Merge "Add release notes links to doc index" 2020-05-26 12:32:54 +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 Improve CONTRIBUTING.rst for clarity 2015-05-16 13:15:50 +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