https://github.com/openstack/specs-cookiecutter
Cookiecutter templates for new specs repos. Mirror of code maintained at opendev.org.
https://github.com/openstack/specs-cookiecutter
Last synced: about 1 year ago
JSON representation
Cookiecutter templates for new specs repos. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/specs-cookiecutter
- Owner: openstack
- Created: 2014-04-04T19:36:25.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-09-17T17:01:26.000Z (almost 5 years ago)
- Last Synced: 2024-05-09T18:51:17.551Z (about 2 years ago)
- Language: Python
- Homepage: https://opendev.org/openstack/specs-cookiecutter
- Size: 29.3 KB
- Stars: 35
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
Awesome Lists containing this project
README
==================
specs-cookiecutter
==================
Cookiecutter template for an OpenStack specs repo projects. See https://github.com/audreyr/cookiecutter.
* Free software: Apache license
* pbr_: Set up to use Python Build Reasonableness
* OpenStack-Infra_: Ready for OpenStack Continuous Integration testing
* Tox_ testing: Setup to easily building sphunx docs
* Sphinx_ docs: Documentation ready for generation and publication
Usage
-----
Generate a Python package project::
cookiecutter https://git.openstack.org/openstack-dev/specs-cookiecutter.git
OpenStack projects 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 $repo_name
git init
git add .
git commit -a
Then:
* Add the project to the OpenStack Infrastructure
.. _pbr: http://docs.openstack.org/developer/pbr
.. _OpenStack-Infra: http://docs.openstack.org/infra/system-config
.. _Tox: http://testrun.org/tox/
.. _Sphinx: http://sphinx-doc.org/