openstack
/
instack
Code Issues Proposed changes

Add cookiecutter code for OpenStack project

This commit is contained in:
James Slagle 2014-02-18 07:37:23 -05:00
parent a160546dd1
commit 3a72756a64
16 changed files with 397 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HACKING.rst Normal file
View File

@ -0,0 +1,4 @@
instack Style Commandments
===============================================
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

314
LICENSE
View File

@ -1,191 +1,175 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
1. Definitions. TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
"License" shall mean the terms and conditions for use, reproduction, and 1. Definitions.
distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright "License" shall mean the terms and conditions for use, reproduction,
owner that is granting the License. and distribution as defined by Sections 1 through 9 of this document.
"Legal Entity" shall mean the union of the acting entity and all other entities "Licensor" shall mean the copyright owner or entity authorized by
that control, are controlled by, or are under common control with that entity. the copyright owner that is granting the License.
For the purposes of this definition, "control" means (i) the power, direct or
indirect, to cause the direction or management of such entity, whether by
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising "Legal Entity" shall mean the union of the acting entity and all
permissions granted by this License. other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"Source" form shall mean the preferred form for making modifications, including "You" (or "Your") shall mean an individual or Legal Entity
but not limited to software source code, documentation source, and configuration exercising permissions granted by this License.
files.
"Object" form shall mean any form resulting from mechanical transformation or "Source" form shall mean the preferred form for making modifications,
translation of a Source form, including but not limited to compiled object code, including but not limited to software source code, documentation
generated documentation, and conversions to other media types. source, and configuration files.
"Work" shall mean the work of authorship, whether in Source or Object form, made "Object" form shall mean any form resulting from mechanical
available under the License, as indicated by a copyright notice that is included transformation or translation of a Source form, including but
in or attached to the work (an example is provided in the Appendix below). not limited to compiled object code, generated documentation,
and conversions to other media types.
"Derivative Works" shall mean any work, whether in Source or Object form, that "Work" shall mean the work of authorship, whether in Source or
is based on (or derived from) the Work and for which the editorial revisions, Object form, made available under the License, as indicated by a
annotations, elaborations, or other modifications represent, as a whole, an copyright notice that is included in or attached to the work
original work of authorship. For the purposes of this License, Derivative Works (an example is provided in the Appendix below).
shall not include works that remain separable from, or merely link (or bind by
name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version "Derivative Works" shall mean any work, whether in Source or Object
of the Work and any modifications or additions to that Work or Derivative Works form, that is based on (or derived from) the Work and for which the
thereof, that is intentionally submitted to Licensor for inclusion in the Work editorial revisions, annotations, elaborations, or other modifications
by the copyright owner or by an individual or Legal Entity authorized to submit represent, as a whole, an original work of authorship. For the purposes
on behalf of the copyright owner. For the purposes of this definition, of this License, Derivative Works shall not include works that remain
"submitted" means any form of electronic, verbal, or written communication sent separable from, or merely link (or bind by name) to the interfaces of,
to the Licensor or its representatives, including but not limited to the Work and Derivative Works thereof.
communication on electronic mailing lists, source code control systems, and
issue tracking systems that are managed by, or on behalf of, the Licensor for
the purpose of discussing and improving the Work, but excluding communication
that is conspicuously marked or otherwise designated in writing by the copyright
owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf "Contribution" shall mean any work of authorship, including
of whom a Contribution has been received by Licensor and subsequently the original version of the Work and any modifications or additions
incorporated within the Work. to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
2. Grant of Copyright License. "Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
Subject to the terms and conditions of this License, each Contributor hereby 2. Grant of Copyright License. Subject to the terms and conditions of
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, this License, each Contributor hereby grants to You a perpetual,
irrevocable copyright license to reproduce, prepare Derivative Works of, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
publicly display, publicly perform, sublicense, and distribute the Work and such copyright license to reproduce, prepare Derivative Works of,
Derivative Works in Source or Object form. publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. 3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
Subject to the terms and conditions of this License, each Contributor hereby 4. Redistribution. You may reproduce and distribute copies of the
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, Work or Derivative Works thereof in any medium, with or without
irrevocable (except as stated in this section) patent license to make, have modifications, and in Source or Object form, provided that You
made, use, offer to sell, sell, import, and otherwise transfer the Work, where meet the following conditions:
such license applies only to those patent claims licensable by such Contributor
that are necessarily infringed by their Contribution(s) alone or by combination
of their Contribution(s) with the Work to which such Contribution(s) was
submitted. If You institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License
for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. (a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
You may reproduce and distribute copies of the Work or Derivative Works thereof (b) You must cause any modified files to carry prominent notices
in any medium, with or without modifications, and in Source or Object form, stating that You changed the files; and
provided that You meet the following conditions:
You must give any other recipients of the Work or Derivative Works a copy of (c) You must retain, in the Source form of any Derivative Works
this License; and that You distribute, all copyright, patent, trademark, and
You must cause any modified files to carry prominent notices stating that You attribution notices from the Source form of the Work,
changed the files; and excluding those notices that do not pertain to any part of
You must retain, in the Source form of any Derivative Works that You distribute, the Derivative Works; and
all copyright, patent, trademark, and attribution notices from the Source form
of the Work, excluding those notices that do not pertain to any part of the
Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any
Derivative Works that You distribute must include a readable copy of the
attribution notices contained within such NOTICE file, excluding those notices
that do not pertain to any part of the Derivative Works, in at least one of the
following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along
with the Derivative Works; or, within a display generated by the Derivative
Works, if and wherever such third-party notices normally appear. The contents of
the NOTICE file are for informational purposes only and do not modify the
License. You may add Your own attribution notices within Derivative Works that
You distribute, alongside or as an addendum to the NOTICE text from the Work,
provided that such additional attribution notices cannot be construed as
modifying the License.
You may add Your own copyright statement to Your modifications and may provide
additional or different license terms and conditions for use, reproduction, or
distribution of Your modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work otherwise complies
with the conditions stated in this License.
5. Submission of Contributions. (d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
Unless You explicitly state otherwise, any Contribution intentionally submitted You may add Your own copyright statement to Your modifications and
for inclusion in the Work by You to the Licensor shall be under the terms and may provide additional or different license terms and conditions
conditions of this License, without any additional terms or conditions. for use, reproduction, or distribution of Your modifications, or
Notwithstanding the above, nothing herein shall supersede or modify the terms of for any such Derivative Works as a whole, provided Your use,
any separate license agreement you may have executed with Licensor regarding reproduction, and distribution of the Work otherwise complies with
such Contributions. the conditions stated in this License.
6. Trademarks. 5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
This License does not grant permission to use the trade names, trademarks, 6. Trademarks. This License does not grant permission to use the trade
service marks, or product names of the Licensor, except as required for names, trademarks, service marks, or product names of the Licensor,
reasonable and customary use in describing the origin of the Work and except as required for reasonable and customary use in describing the
reproducing the content of the NOTICE file. origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. 7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
Unless required by applicable law or agreed to in writing, Licensor provides the 8. Limitation of Liability. In no event and under no legal theory,
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, whether in tort (including negligence), contract, or otherwise,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, unless required by applicable law (such as deliberate and grossly
including, without limitation, any warranties or conditions of TITLE, negligent acts) or agreed to in writing, shall any Contributor be
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are liable to You for damages, including any direct, indirect, special,
solely responsible for determining the appropriateness of using or incidental, or consequential damages of any character arising as a
redistributing the Work and assume any risks associated with Your exercise of result of this License or out of the use or inability to use the
permissions under this License. Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
8. Limitation of Liability. 9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
In no event and under no legal theory, whether in tort (including negligence), and charge a fee for, acceptance of support, warranty, indemnity,
contract, or otherwise, unless required by applicable law (such as deliberate or other liability obligations and/or rights consistent with this
and grossly negligent acts) or agreed to in writing, shall any Contributor be License. However, in accepting such obligations, You may act only
liable to You for damages, including any direct, indirect, special, incidental, on Your own behalf and on Your sole responsibility, not on behalf
or consequential damages of any character arising as a result of this License or of any other Contributor, and only if You agree to indemnify,
out of the use or inability to use the Work (including but not limited to defend, and hold each Contributor harmless for any liability
damages for loss of goodwill, work stoppage, computer failure or malfunction, or incurred by, or claims asserted against, such Contributor by reason
any and all other commercial damages or losses), even if such Contributor has of your accepting any such warranty or additional liability.
been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability.
While redistributing the Work or Derivative Works thereof, You may choose to
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
other liability obligations and/or rights consistent with this License. However,
in accepting such obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason of your
accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work
To apply the Apache License to your work, attach the following boilerplate
notice, with the fields enclosed by brackets "[]" replaced with your own
identifying information. (Don't include the brackets!) The text should be
enclosed in the appropriate comment syntax for the file format. We also
recommend that a file or class name and description of purpose be included on
the same "printed page" as the copyright notice for easier identification within
third-party archives.
Copyright [yyyy] [name of copyright owner]
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.

6
MANIFEST.in Normal file
View File

@ -0,0 +1,6 @@
include AUTHORS
include ChangeLog
exclude .gitignore
exclude .gitreview
global-exclude *.pyc

1
babel.cfg Normal file
View File

@ -0,0 +1 @@
[python: **.py]

75
doc/source/conf.py Executable file
View File

@ -0,0 +1,75 @@
# -*- 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',
'oslo.sphinx'
]
# 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'instack'
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}

1
doc/source/contributing.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../CONTRIBUTING.rst

24
doc/source/index.rst Normal file
View File

@ -0,0 +1,24 @@
.. instack 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.
Welcome to instack's documentation!
========================================================
Contents:
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

12
doc/source/installation.rst Normal file
View File

@ -0,0 +1,12 @@
============
Installation
============
At the command line::
$ pip install instack
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv instack
$ pip install instack

1
doc/source/readme.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../README.rst

7
doc/source/usage.rst Normal file
View File

@ -0,0 +1,7 @@
========
Usage
========
To use instack in a project::
import instack

7
openstack-common.conf Normal file
View File

@ -0,0 +1,7 @@
[DEFAULT]
# The list of modules to copy from oslo-incubator.git
module=install_venv_common
# The base module to hold the copy of openstack.common
base=instack

2
requirements.txt Normal file
View File

@ -0,0 +1,2 @@
pbr>=0.5.21,<1.0
Babel>=0.9.6

50
setup.cfg Normal file
View File

@ -0,0 +1,50 @@
[metadata]
name = instack
summary = instack
description-file =
README.md
author = James Slagle
author-email = jslagle@redhat.com
home-page = http://www.redhat.com/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 2.6
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
[files]
packages =
instack
[entry_points]
console_scripts =
instack = instack.main:main
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog]
directory = instack/locale
domain = instack
[update_catalog]
domain = instack
output_dir = instack/locale
input_file = instack/locale/instack.pot
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = instack/locale/instack.pot

39
setup.py
View File

@ -1,29 +1,22 @@
# Copyright 2013, Red Hat Inc. #!/usr/bin/env python
# All Rights Reserved. # Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
# #
# Licensed under the Apache License, Version 2.0 (the "License"); you may # Licensed under the Apache License, Version 2.0 (the "License");
# not use this file except in compliance with the License. You may obtain # you may not use this file except in compliance with the License.
# a copy of the License at # You may obtain a copy of the License at
# #
# http://www.apache.org/licenses/LICENSE-2.0 # http://www.apache.org/licenses/LICENSE-2.0
# #
# Unless required by applicable law or agreed to in writing, software # Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # distributed under the License is distributed on an "AS IS" BASIS,
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# License for the specific language governing permissions and limitations # implied.
# under the License. # 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
from setuptools import setup, find_packages setuptools.setup(
setup_requires=['pbr>=0.5.21,<1.0'],
setup( pbr=True)
name = "instack",
description = "Execute diskimage-builder elements on the current system.",
version = "0.1",
packages = find_packages(),
entry_points = {
'console_scripts': [
'instack = instack.main:main',
],
},
)

11
test-requirements.txt Normal file
View File

@ -0,0 +1,11 @@
hacking>=0.5.6,<0.8
coverage>=3.6
discover
fixtures>=0.3.14
python-subunit
sphinx>=1.1.2
oslo.sphinx
testrepository>=0.0.17
testscenarios>=0.4,<0.5
testtools>=0.9.32

31
tox.ini Normal file
View File

@ -0,0 +1,31 @@
[tox]
minversion = 1.6
envlist = py26,py27,py33,pypy,pep8
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
commands = python setup.py testr --slowest --testr-args='{posargs}'
[testenv:pep8]
commands = flake8
[testenv:venv]
commands = {posargs}
[testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}'
[flake8]
# H803 skipped on purpose per list discussion.
# E123, E125 skipped as they are invalid PEP-8.
show-source = True
ignore = E123,E125,H803
builtins = _
exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build