Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openstack/cookiecutter

Cookiecutter Template for new OpenStack projects. Mirror of code maintained at opendev.org.
https://github.com/openstack/cookiecutter

Last synced: about 3 hours ago
JSON representation

Cookiecutter Template for new OpenStack projects. Mirror of code maintained at opendev.org.

Host: GitHub
URL: https://github.com/openstack/cookiecutter
Owner: openstack
Created: 2013-09-09T17:10:26.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2022-03-22T12:32:48.000Z (over 2 years ago)
Last Synced: 2024-11-08T02:32:38.710Z (6 days ago)
Language: Python
Homepage: https://opendev.org/openstack/cookiecutter
Size: 151 KB
Stars: 80
Watchers: 11
Forks: 22
Open Issues: 0
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst

Awesome Lists containing this project

README

        ======================

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

.. _pbr: https://docs.openstack.org/pbr/latest/

.. _OpenStack-Infra: https://docs.openstack.org/infra/system-config

.. _stestr: https://stestr.readthedocs.io/

.. _Tox: https://tox.readthedocs.io/en/latest/

.. _Sphinx: https://www.sphinx-doc.org/en/master/

.. _hacking: https://opendev.org/openstack/hacking/