Andreas Jaeger 02e6702c9f Update CONTRIBUTING
Sync {{cookiecutter.repo_name}}/CONTRIBUTING.rst with CONTRIBUTING.rst,
we should use the same content that we push everybody else to use.

Change-Id: Iff1e4d49bb88b84e96be097bbfd8a5cba5932df1
2020-03-21 08:54:52 +01:00
2019-04-19 19:40:16 +00:00
2020-03-21 08:54:52 +01:00

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
Description
Cookiecutter Template for new OpenStack projects
Readme 975 KiB
Languages
Python 99.4%
Shell 0.6%