openstack
/
cookiecutter
Code Issues Proposed changes
Cookiecutter Template for new OpenStack projects
201 Commits 1 Branch 0 Tags 975 KiB
Python 99.4%
Shell 0.6%
Go to file
Radosław Piliszek f1036368c7 Fix docs whitespace 
Too aggressive trimming caused lines and indents to go lost.
This patch makes docs whitespace just right (TM).

Change-Id: If10bc6cb10c8cd26bb7ea7a071d9f0e4f34235b5
 		2020-07-23 14:55:10 +02:00
hooks Automatically initialize git when finished. 2014-09-04 14:59:03 +10:00
releasenotes/notes [ussuri][goal] Drop python 2.7 support and testing 2020-02-06 10:27:58 +01:00
{{cookiecutter.repo_name}} Fix docs whitespace 2020-07-23 14:55:10 +02:00
.gitignore Clean up .gitignore references to personal tools 2018-08-16 15:13:50 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:40:16 +00:00
CONTRIBUTING.rst Update CONTRIBUTING 2020-03-21 08:54:52 +01:00
README.rst Remove py27 support for future projects 2019-11-14 15:33:41 +01:00
cookiecutter.json Fixed two issues regarding cookiecutter template 2018-06-02 13:42:46 +02:00

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