commit
b3f450790f
21 changed files with 511 additions and 0 deletions
@ -0,0 +1,7 @@
|
||||
[run] |
||||
branch = True |
||||
source = marconi-specs |
||||
omit = marconi-specs/tests/*,marconi-specs/openstack/* |
||||
|
||||
[report] |
||||
ignore-errors = True |
@ -0,0 +1,51 @@
|
||||
*.py[cod] |
||||
|
||||
# C extensions |
||||
*.so |
||||
|
||||
# Packages |
||||
*.egg |
||||
*.egg-info |
||||
dist |
||||
build |
||||
eggs |
||||
parts |
||||
bin |
||||
var |
||||
sdist |
||||
develop-eggs |
||||
.installed.cfg |
||||
lib |
||||
lib64 |
||||
|
||||
# Installer logs |
||||
pip-log.txt |
||||
|
||||
# Unit test / coverage reports |
||||
.coverage |
||||
.tox |
||||
nosetests.xml |
||||
.testrepository |
||||
|
||||
# Translations |
||||
*.mo |
||||
|
||||
# Mr Developer |
||||
.mr.developer.cfg |
||||
.project |
||||
.pydevproject |
||||
|
||||
# Complexity |
||||
output/*.html |
||||
output/*/index.html |
||||
|
||||
# Sphinx |
||||
doc/build |
||||
|
||||
# pbr generates these |
||||
AUTHORS |
||||
ChangeLog |
||||
|
||||
# Editors |
||||
*~ |
||||
.*.swp |
@ -0,0 +1,4 @@
|
||||
[gerrit] |
||||
host=review.openstack.org |
||||
port=29418 |
||||
project=openstack/marconi-specs.git |
@ -0,0 +1,3 @@
|
||||
# Format is: |
||||
# <preferred e-mail> <other e-mail 1> |
||||
# <preferred e-mail> <other e-mail 2> |
@ -0,0 +1,7 @@
|
||||
[DEFAULT] |
||||
test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ |
||||
OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ |
||||
OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ |
||||
${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION |
||||
test_id_option=--load-list $IDFILE |
||||
test_list_option=--list |
@ -0,0 +1,21 @@
|
||||
============================================= |
||||
Contributing to: marconi-specs |
||||
============================================= |
||||
|
||||
If you would like to contribute to the development of OpenStack, |
||||
you must follow the steps in the "If you're a developer, start here" |
||||
section of this page: |
||||
|
||||
http://wiki.openstack.org/HowToContribute |
||||
|
||||
Once those steps have been completed, changes to OpenStack |
||||
should be submitted for review via the Gerrit tool, following |
||||
the workflow documented at: |
||||
|
||||
http://wiki.openstack.org/GerritWorkflow |
||||
|
||||
Pull requests submitted through GitHub will be ignored. |
||||
|
||||
Bugs should be filed on Launchpad, not GitHub: |
||||
|
||||
https://bugs.launchpad.net/marconi |
@ -0,0 +1,3 @@
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported License. |
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode |
@ -0,0 +1,6 @@
|
||||
include AUTHORS |
||||
include ChangeLog |
||||
exclude .gitignore |
||||
exclude .gitreview |
||||
|
||||
global-exclude *.pyc |
@ -0,0 +1,13 @@
|
||||
=============================== |
||||
marconi-specs |
||||
=============================== |
||||
|
||||
Queuing Service (Marconi) Specifications |
||||
|
||||
* Free software: Apache license |
||||
* Documentation: http://docs.openstack.org/developer/marconi-specs |
||||
|
||||
Features |
||||
-------- |
||||
|
||||
* TODO |
@ -0,0 +1,83 @@
|
||||
# -*- coding: utf-8 -*- |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
# implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
import os |
||||
import sys |
||||
|
||||
sys.path.insert(0, os.path.abspath('../..')) |
||||
# -- General configuration ---------------------------------------------------- |
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be |
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
||||
extensions = [ |
||||
'sphinx.ext.autodoc', |
||||
#'sphinx.ext.intersphinx', |
||||
'oslosphinx' |
||||
] |
||||
|
||||
# Optionally allow the use of sphinxcontrib.spelling to verify the |
||||
# spelling of the documents. |
||||
try: |
||||
import sphinxcontrib.spelling |
||||
extensions.append('sphinxcontrib.spelling') |
||||
except ImportError: |
||||
pass |
||||
|
||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy |
||||
# text edit cycles. |
||||
# execute "export SPHINX_DEBUG=1" in your terminal to disable |
||||
|
||||
# The suffix of source filenames. |
||||
source_suffix = '.rst' |
||||
|
||||
# The master toctree document. |
||||
master_doc = 'index' |
||||
|
||||
# General information about the project. |
||||
project = u'marconi-specs' |
||||
copyright = u'2013, OpenStack Foundation' |
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text. |
||||
add_function_parentheses = True |
||||
|
||||
# If true, the current module name will be prepended to all description |
||||
# unit titles (such as .. function::). |
||||
add_module_names = True |
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use. |
||||
pygments_style = 'sphinx' |
||||
|
||||
# -- Options for HTML output -------------------------------------------------- |
||||
|
||||
# The theme to use for HTML and HTML Help pages. Major themes that come with |
||||
# Sphinx are currently 'default' and 'sphinxdoc'. |
||||
# html_theme_path = ["."] |
||||
# html_theme = '_theme' |
||||
# html_static_path = ['static'] |
||||
|
||||
# Output file base name for HTML help builder. |
||||
htmlhelp_basename = '%sdoc' % project |
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples |
||||
# (source start file, target name, title, author, documentclass |
||||
# [howto/manual]). |
||||
latex_documents = [ |
||||
('index', |
||||
'%s.tex' % project, |
||||
u'%s Documentation' % project, |
||||
u'OpenStack Foundation', 'manual'), |
||||
] |
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library. |
||||
#intersphinx_mapping = {'http://docs.python.org/': None} |
@ -0,0 +1,21 @@
|
||||
============================================= |
||||
Contributing to: marconi-specs |
||||
============================================= |
||||
|
||||
If you would like to contribute to the development of OpenStack, |
||||
you must follow the steps in the "If you're a developer, start here" |
||||
section of this page: |
||||
|
||||
http://wiki.openstack.org/HowToContribute |
||||
|
||||
Once those steps have been completed, changes to OpenStack |
||||
should be submitted for review via the Gerrit tool, following |
||||
the workflow documented at: |
||||
|
||||
http://wiki.openstack.org/GerritWorkflow |
||||
|
||||
Pull requests submitted through GitHub will be ignored. |
||||
|
||||
Bugs should be filed on Launchpad, not GitHub: |
||||
|
||||
https://bugs.launchpad.net/marconi |
@ -0,0 +1,32 @@
|
||||
.. marconi-specs documentation master file, created by |
||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013. |
||||
You can adapt this file completely to your liking, but it should at least |
||||
contain the root `toctree` directive. |
||||
|
||||
marconi-specs Design Specifications |
||||
================================================== |
||||
|
||||
.. toctree:: |
||||
:glob: |
||||
:maxdepth: 2 |
||||
|
||||
../../specs/* |
||||
|
||||
|
||||
marconi-specs Repository Information |
||||
=================================================== |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
|
||||
README <readme> |
||||
contributing |
||||
Sample Template <template> |
||||
|
||||
|
||||
Indices and tables |
||||
================== |
||||
|
||||
* :ref:`genindex` |
||||
* :ref:`modindex` |
||||
* :ref:`search` |
@ -0,0 +1,13 @@
|
||||
=============================== |
||||
marconi-specs |
||||
=============================== |
||||
|
||||
Queuing Service (Marconi) Specifications |
||||
|
||||
* Free software: Apache license |
||||
* Documentation: http://docs.openstack.org/developer/marconi-specs |
||||
|
||||
Features |
||||
-------- |
||||
|
||||
* TODO |
@ -0,0 +1,86 @@
|
||||
:: |
||||
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported License. |
||||
http://creativecommons.org/licenses/by/3.0/legalcode |
||||
|
||||
.. |
||||
This template should be in ReSTructured text. The filename in the git |
||||
repository should match the launchpad URL, for example a URL of |
||||
https://blueprints.launchpad.net/marconi/+spec/awesome-thing should be named |
||||
awesome-thing.rst . Please do not delete any of the sections in this |
||||
template. If you have nothing to say for a whole section, just write: None |
||||
For help with syntax, see http://sphinx-doc.org/rest.html |
||||
To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html |
||||
|
||||
============================= |
||||
The title of your blueprint |
||||
============================= |
||||
|
||||
Include the URL of your launchpad blueprint: |
||||
|
||||
https://blueprints.launchpad.net//+spec/example |
||||
|
||||
Introduction paragraph -- why are we doing anything? |
||||
|
||||
Problem description |
||||
=================== |
||||
|
||||
A detailed description of the problem. |
||||
|
||||
Proposed change |
||||
=============== |
||||
|
||||
Here is where you cover the change you propose to make in detail. How do you |
||||
propose to solve this problem? |
||||
|
||||
If this is one part of a larger effort make it clear where this piece ends. In |
||||
other words, what's the scope of this effort? |
||||
|
||||
Include where in the marconi tree hierarchy this will reside. |
||||
|
||||
Alternatives |
||||
------------ |
||||
|
||||
This is an optional section, where it does apply we'd just like a demonstration |
||||
that some thought has been put into why the proposed approach is the best one. |
||||
|
||||
Implementation |
||||
============== |
||||
|
||||
Assignee(s) |
||||
----------- |
||||
|
||||
Who is leading the writing of the code? Or is this a blueprint where you're |
||||
throwing it out there to see who picks it up? |
||||
|
||||
If more than one person is working on the implementation, please designate the |
||||
primary author and contact. |
||||
|
||||
Primary assignee: |
||||
<launchpad-id or None> |
||||
|
||||
Can optionally can list additional ids if they intend on doing |
||||
substantial implementation work on this blueprint. |
||||
|
||||
Milestones |
||||
---------- |
||||
|
||||
Target Milestone for completion: |
||||
Juno-1 |
||||
|
||||
Work Items |
||||
---------- |
||||
|
||||
Work items or tasks -- break the feature up into the things that need to be |
||||
done to implement it. Those parts might end up being done by different people, |
||||
but we're mostly trying to understand the timeline for implementation. |
||||
|
||||
|
||||
Dependencies |
||||
============ |
||||
|
||||
- Include specific references to specs and/or blueprints in marconi, or in other |
||||
projects, that this one either depends on or is related to. |
||||
|
||||
- Does this feature require any new library dependencies or code otherwise not |
||||
included in OpenStack? Or does it depend on a specific version of library? |
@ -0,0 +1,4 @@
|
||||
pbr>=0.6,<1.0 |
||||
docutils==0.9.1 |
||||
oslosphinx |
||||
sphinx>=1.1.2,<1.2 |
@ -0,0 +1,24 @@
|
||||
[metadata] |
||||
name = marconi-specs |
||||
summary = Queuing Service (Marconi) Specifications |
||||
description-file = |
||||
README.rst |
||||
author = OpenStack |
||||
author-email = openstack-dev@lists.openstack.org |
||||
home-page = http://www.openstack.org/ |
||||
classifier = |
||||
Environment :: OpenStack |
||||
Intended Audience :: Developers |
||||
License :: OSI Approved :: Apache Software License |
||||
Operating System :: POSIX :: Linux |
||||
|
||||
[build_sphinx] |
||||
source-dir = doc/source |
||||
build-dir = doc/build |
||||
all_files = 1 |
||||
|
||||
[pbr] |
||||
warnerrors = True |
||||
|
||||
[upload_sphinx] |
||||
upload-dir = doc/build/html |
@ -0,0 +1,22 @@
|
||||
#!/usr/bin/env python |
||||
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
# implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT |
||||
import setuptools |
||||
|
||||
setuptools.setup( |
||||
setup_requires=['pbr>=0.6,<1.0'], |
||||
pbr=True) |
@ -0,0 +1,86 @@
|
||||
:: |
||||
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported License. |
||||
http://creativecommons.org/licenses/by/3.0/legalcode |
||||
|
||||
.. |
||||
This template should be in ReSTructured text. The filename in the git |
||||
repository should match the launchpad URL, for example a URL of |
||||
https://blueprints.launchpad.net/marconi/+spec/awesome-thing should be named |
||||
awesome-thing.rst . Please do not delete any of the sections in this |
||||
template. If you have nothing to say for a whole section, just write: None |
||||
For help with syntax, see http://sphinx-doc.org/rest.html |
||||
To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html |
||||
|
||||
============================= |
||||
The title of your blueprint |
||||
============================= |
||||
|
||||
Include the URL of your launchpad blueprint: |
||||
|
||||
https://blueprints.launchpad.net//+spec/example |
||||
|
||||
Introduction paragraph -- why are we doing anything? |
||||
|
||||
Problem description |
||||
=================== |
||||
|
||||
A detailed description of the problem. |
||||
|
||||
Proposed change |
||||
=============== |
||||
|
||||
Here is where you cover the change you propose to make in detail. How do you |
||||
propose to solve this problem? |
||||
|
||||
If this is one part of a larger effort make it clear where this piece ends. In |
||||
other words, what's the scope of this effort? |
||||
|
||||
Include where in the marconi tree hierarchy this will reside. |
||||
|
||||
Alternatives |
||||
------------ |
||||
|
||||
This is an optional section, where it does apply we'd just like a demonstration |
||||
that some thought has been put into why the proposed approach is the best one. |
||||
|
||||
Implementation |
||||
============== |
||||
|
||||
Assignee(s) |
||||
----------- |
||||
|
||||
Who is leading the writing of the code? Or is this a blueprint where you're |
||||
throwing it out there to see who picks it up? |
||||
|
||||
If more than one person is working on the implementation, please designate the |
||||
primary author and contact. |
||||
|
||||
Primary assignee: |
||||
<launchpad-id or None> |
||||
|
||||
Can optionally can list additional ids if they intend on doing |
||||
substantial implementation work on this blueprint. |
||||
|
||||
Milestones |
||||
---------- |
||||
|
||||
Target Milestone for completion: |
||||
Juno-1 |
||||
|
||||
Work Items |
||||
---------- |
||||
|
||||
Work items or tasks -- break the feature up into the things that need to be |
||||
done to implement it. Those parts might end up being done by different people, |
||||
but we're mostly trying to understand the timeline for implementation. |
||||
|
||||
|
||||
Dependencies |
||||
============ |
||||
|
||||
- Include specific references to specs and/or blueprints in marconi, or in other |
||||
projects, that this one either depends on or is related to. |
||||
|
||||
- Does this feature require any new library dependencies or code otherwise not |
||||
included in OpenStack? Or does it depend on a specific version of library? |
@ -0,0 +1,25 @@
|
||||
[tox] |
||||
minversion = 1.6 |
||||
envlist = docs |
||||
skipsdist = True |
||||
|
||||
[testenv] |
||||
usedevelop = True |
||||
install_command = pip install -U {opts} {packages} |
||||
setenv = |
||||
VIRTUAL_ENV={envdir} |
||||
deps = -r{toxinidir}/requirements.txt |
||||
-r{toxinidir}/test-requirements.txt |
||||
|
||||
[testenv:venv] |
||||
commands = {posargs} |
||||
|
||||
[testenv:docs] |
||||
commands = python setup.py build_sphinx |
||||
|
||||
[testenv:spelling] |
||||
deps = |
||||
-r{toxinidir}/requirements.txt |
||||
sphinxcontrib-spelling |
||||
PyEnchant |
||||
commands = sphinx-build -b spelling doc/source doc/build/spelling |
Loading…
Reference in new issue