summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTetsuro Nakamura <nakamura.tetsuro@lab.ntt.co.jp>2017-10-25 11:19:22 +0900
committerTetsuro Nakamura <nakamura.tetsuro@lab.ntt.co.jp>2017-10-25 12:01:49 +0900
commit85c0f8c938f99b9a83ab0c861695dee9be9d8b74 (patch)
treed17234c5d28f16c3e44448d9ea0f97a7e1a9aa37
parentefdc3530577d8d3cad809a79362f7f8c94fa64a1 (diff)
Initial Cookiecutter Commit.
Notes
Notes (review): Code-Review+2: Tetsuro Nakamura <nakamura.tetsuro@lab.ntt.co.jp> Workflow+1: Tetsuro Nakamura <nakamura.tetsuro@lab.ntt.co.jp> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 25 Oct 2017 05:22:29 +0000 Reviewed-on: https://review.openstack.org/514897 Project: openstack/networking-spp Branch: refs/heads/master
-rw-r--r--.coveragerc6
-rw-r--r--.gitignore59
-rw-r--r--.mailmap3
-rw-r--r--.stestr.conf3
-rw-r--r--CONTRIBUTING.rst17
-rw-r--r--HACKING.rst4
-rw-r--r--LICENSE176
-rw-r--r--README.rst19
-rw-r--r--babel.cfg2
-rwxr-xr-xdoc/source/conf.py81
-rw-r--r--doc/source/configuration/index.rst5
-rw-r--r--doc/source/contributor/contributing.rst4
-rw-r--r--doc/source/contributor/index.rst9
-rw-r--r--doc/source/index.rst28
-rw-r--r--doc/source/install/index.rst14
-rw-r--r--doc/source/install/install.rst20
-rw-r--r--doc/source/library/index.rst7
-rw-r--r--doc/source/readme.rst1
-rw-r--r--doc/source/reference/index.rst5
-rw-r--r--doc/source/user/index.rst5
-rw-r--r--networking_spp/__init__.py19
-rw-r--r--networking_spp/tests/__init__.py0
-rw-r--r--networking_spp/tests/base.py23
-rw-r--r--networking_spp/tests/test_networking_spp.py28
-rw-r--r--releasenotes/notes/.placeholder0
-rw-r--r--releasenotes/source/_static/.placeholder0
-rw-r--r--releasenotes/source/_templates/.placeholder0
-rw-r--r--releasenotes/source/conf.py280
-rw-r--r--releasenotes/source/index.rst8
-rw-r--r--releasenotes/source/unreleased.rst5
-rw-r--r--requirements.txt5
-rw-r--r--setup.cfg47
-rw-r--r--setup.py29
-rw-r--r--test-requirements.txt15
-rw-r--r--tox.ini50
35 files changed, 977 insertions, 0 deletions
diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..c538889
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,6 @@
1[run]
2branch = True
3source = networking_spp
4
5[report]
6ignore_errors = True
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..59b35f5
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,59 @@
1*.py[cod]
2
3# C extensions
4*.so
5
6# Packages
7*.egg*
8*.egg-info
9dist
10build
11eggs
12parts
13bin
14var
15sdist
16develop-eggs
17.installed.cfg
18lib
19lib64
20
21# Installer logs
22pip-log.txt
23
24# Unit test / coverage reports
25cover/
26.coverage*
27!.coveragerc
28.tox
29nosetests.xml
30.testrepository
31.stestr
32.venv
33
34# Translations
35*.mo
36
37# Mr Developer
38.mr.developer.cfg
39.project
40.pydevproject
41
42# Complexity
43output/*.html
44output/*/index.html
45
46# Sphinx
47doc/build
48
49# pbr generates these
50AUTHORS
51ChangeLog
52
53# Editors
54*~
55.*.swp
56.*sw?
57
58# Files created by releasenotes build
59releasenotes/build
diff --git a/.mailmap b/.mailmap
new file mode 100644
index 0000000..516ae6f
--- /dev/null
+++ b/.mailmap
@@ -0,0 +1,3 @@
1# Format is:
2# <preferred e-mail> <other e-mail 1>
3# <preferred e-mail> <other e-mail 2>
diff --git a/.stestr.conf b/.stestr.conf
new file mode 100644
index 0000000..8294e6b
--- /dev/null
+++ b/.stestr.conf
@@ -0,0 +1,3 @@
1[DEFAULT]
2test_path=./networking_spp/tests
3top_dir=./
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..285220e
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,17 @@
1If you would like to contribute to the development of OpenStack, you must
2follow the steps in this page:
3
4 http://docs.openstack.org/infra/manual/developers.html
5
6If you already have a good understanding of how the system works and your
7OpenStack accounts are set up, you can skip to the development workflow
8section of this documentation to learn how changes to OpenStack should be
9submitted for review via the Gerrit tool:
10
11 http://docs.openstack.org/infra/manual/developers.html#development-workflow
12
13Pull requests submitted through GitHub will be ignored.
14
15Bugs should be filed on Launchpad, not GitHub:
16
17 https://bugs.launchpad.net/networking-spp
diff --git a/HACKING.rst b/HACKING.rst
new file mode 100644
index 0000000..45d2a28
--- /dev/null
+++ b/HACKING.rst
@@ -0,0 +1,4 @@
1networking-spp Style Commandments
2===============================================
3
4Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..68c771a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,176 @@
1
2 Apache License
3 Version 2.0, January 2004
4 http://www.apache.org/licenses/
5
6 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
8 1. Definitions.
9
10 "License" shall mean the terms and conditions for use, reproduction,
11 and distribution as defined by Sections 1 through 9 of this document.
12
13 "Licensor" shall mean the copyright owner or entity authorized by
14 the copyright owner that is granting the License.
15
16 "Legal Entity" shall mean the union of the acting entity and all
17 other entities that control, are controlled by, or are under common
18 control with that entity. For the purposes of this definition,
19 "control" means (i) the power, direct or indirect, to cause the
20 direction or management of such entity, whether by contract or
21 otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 outstanding shares, or (iii) beneficial ownership of such entity.
23
24 "You" (or "Your") shall mean an individual or Legal Entity
25 exercising permissions granted by this License.
26
27 "Source" form shall mean the preferred form for making modifications,
28 including but not limited to software source code, documentation
29 source, and configuration files.
30
31 "Object" form shall mean any form resulting from mechanical
32 transformation or translation of a Source form, including but
33 not limited to compiled object code, generated documentation,
34 and conversions to other media types.
35
36 "Work" shall mean the work of authorship, whether in Source or
37 Object form, made available under the License, as indicated by a
38 copyright notice that is included in or attached to the work
39 (an example is provided in the Appendix below).
40
41 "Derivative Works" shall mean any work, whether in Source or Object
42 form, that is based on (or derived from) the Work and for which the
43 editorial revisions, annotations, elaborations, or other modifications
44 represent, as a whole, an original work of authorship. For the purposes
45 of this License, Derivative Works shall not include works that remain
46 separable from, or merely link (or bind by name) to the interfaces of,
47 the Work and Derivative Works thereof.
48
49 "Contribution" shall mean any work of authorship, including
50 the original version of the Work and any modifications or additions
51 to that Work or Derivative Works thereof, that is intentionally
52 submitted to Licensor for inclusion in the Work by the copyright owner
53 or by an individual or Legal Entity authorized to submit on behalf of
54 the copyright owner. For the purposes of this definition, "submitted"
55 means any form of electronic, verbal, or written communication sent
56 to the Licensor or its representatives, including but not limited to
57 communication on electronic mailing lists, source code control systems,
58 and issue tracking systems that are managed by, or on behalf of, the
59 Licensor for the purpose of discussing and improving the Work, but
60 excluding communication that is conspicuously marked or otherwise
61 designated in writing by the copyright owner as "Not a Contribution."
62
63 "Contributor" shall mean Licensor and any individual or Legal Entity
64 on behalf of whom a Contribution has been received by Licensor and
65 subsequently incorporated within the Work.
66
67 2. Grant of Copyright License. Subject to the terms and conditions of
68 this License, each Contributor hereby grants to You a perpetual,
69 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 copyright license to reproduce, prepare Derivative Works of,
71 publicly display, publicly perform, sublicense, and distribute the
72 Work and such Derivative Works in Source or Object form.
73
74 3. Grant of Patent License. Subject to the terms and conditions of
75 this License, each Contributor hereby grants to You a perpetual,
76 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 (except as stated in this section) patent license to make, have made,
78 use, offer to sell, sell, import, and otherwise transfer the Work,
79 where such license applies only to those patent claims licensable
80 by such Contributor that are necessarily infringed by their
81 Contribution(s) alone or by combination of their Contribution(s)
82 with the Work to which such Contribution(s) was submitted. If You
83 institute patent litigation against any entity (including a
84 cross-claim or counterclaim in a lawsuit) alleging that the Work
85 or a Contribution incorporated within the Work constitutes direct
86 or contributory patent infringement, then any patent licenses
87 granted to You under this License for that Work shall terminate
88 as of the date such litigation is filed.
89
90 4. Redistribution. You may reproduce and distribute copies of the
91 Work or Derivative Works thereof in any medium, with or without
92 modifications, and in Source or Object form, provided that You
93 meet the following conditions:
94
95 (a) You must give any other recipients of the Work or
96 Derivative Works a copy of this License; and
97
98 (b) You must cause any modified files to carry prominent notices
99 stating that You changed the files; and
100
101 (c) You must retain, in the Source form of any Derivative Works
102 that You distribute, all copyright, patent, trademark, and
103 attribution notices from the Source form of the Work,
104 excluding those notices that do not pertain to any part of
105 the Derivative Works; and
106
107 (d) If the Work includes a "NOTICE" text file as part of its
108 distribution, then any Derivative Works that You distribute must
109 include a readable copy of the attribution notices contained
110 within such NOTICE file, excluding those notices that do not
111 pertain to any part of the Derivative Works, in at least one
112 of the following places: within a NOTICE text file distributed
113 as part of the Derivative Works; within the Source form or
114 documentation, if provided along with the Derivative Works; or,
115 within a display generated by the Derivative Works, if and
116 wherever such third-party notices normally appear. The contents
117 of the NOTICE file are for informational purposes only and
118 do not modify the License. You may add Your own attribution
119 notices within Derivative Works that You distribute, alongside
120 or as an addendum to the NOTICE text from the Work, provided
121 that such additional attribution notices cannot be construed
122 as modifying the License.
123
124 You may add Your own copyright statement to Your modifications and
125 may provide additional or different license terms and conditions
126 for use, reproduction, or distribution of Your modifications, or
127 for any such Derivative Works as a whole, provided Your use,
128 reproduction, and distribution of the Work otherwise complies with
129 the conditions stated in this License.
130
131 5. Submission of Contributions. Unless You explicitly state otherwise,
132 any Contribution intentionally submitted for inclusion in the Work
133 by You to the Licensor shall be under the terms and conditions of
134 this License, without any additional terms or conditions.
135 Notwithstanding the above, nothing herein shall supersede or modify
136 the terms of any separate license agreement you may have executed
137 with Licensor regarding such Contributions.
138
139 6. Trademarks. This License does not grant permission to use the trade
140 names, trademarks, service marks, or product names of the Licensor,
141 except as required for reasonable and customary use in describing the
142 origin of the Work and reproducing the content of the NOTICE file.
143
144 7. Disclaimer of Warranty. Unless required by applicable law or
145 agreed to in writing, Licensor provides the Work (and each
146 Contributor provides its Contributions) on an "AS IS" BASIS,
147 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 implied, including, without limitation, any warranties or conditions
149 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 PARTICULAR PURPOSE. You are solely responsible for determining the
151 appropriateness of using or redistributing the Work and assume any
152 risks associated with Your exercise of permissions under this License.
153
154 8. Limitation of Liability. In no event and under no legal theory,
155 whether in tort (including negligence), contract, or otherwise,
156 unless required by applicable law (such as deliberate and grossly
157 negligent acts) or agreed to in writing, shall any Contributor be
158 liable to You for damages, including any direct, indirect, special,
159 incidental, or consequential damages of any character arising as a
160 result of this License or out of the use or inability to use the
161 Work (including but not limited to damages for loss of goodwill,
162 work stoppage, computer failure or malfunction, or any and all
163 other commercial damages or losses), even if such Contributor
164 has been advised of the possibility of such damages.
165
166 9. Accepting Warranty or Additional Liability. While redistributing
167 the Work or Derivative Works thereof, You may choose to offer,
168 and charge a fee for, acceptance of support, warranty, indemnity,
169 or other liability obligations and/or rights consistent with this
170 License. However, in accepting such obligations, You may act only
171 on Your own behalf and on Your sole responsibility, not on behalf
172 of any other Contributor, and only if You agree to indemnify,
173 defend, and hold each Contributor harmless for any liability
174 incurred by, or claims asserted against, such Contributor by reason
175 of your accepting any such warranty or additional liability.
176
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..c9f282f
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,19 @@
1===============================
2networking-spp
3===============================
4
5Neutron plugin for Soft Patch Panel
6
7Please fill here a long description which must be at least 3 lines wrapped on
880 cols, so that distribution package maintainers can use it in their packages.
9Note that this is a hard requirement.
10
11* Free software: Apache license
12* Documentation: https://docs.openstack.org/networking-spp/latest
13* Source: https://git.openstack.org/cgit/openstack/networking-spp
14* Bugs: https://bugs.launchpad.net/networking-spp
15
16Features
17--------
18
19* TODO
diff --git a/babel.cfg b/babel.cfg
new file mode 100644
index 0000000..15cd6cb
--- /dev/null
+++ b/babel.cfg
@@ -0,0 +1,2 @@
1[python: **.py]
2
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100755
index 0000000..089fec2
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,81 @@
1# -*- coding: utf-8 -*-
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11# implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import os
16import sys
17
18sys.path.insert(0, os.path.abspath('../..'))
19# -- General configuration ----------------------------------------------------
20
21# Add any Sphinx extension module names here, as strings. They can be
22# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23extensions = [
24 'sphinx.ext.autodoc',
25 'openstackdocstheme',
26 #'sphinx.ext.intersphinx',
27]
28
29# autodoc generation is a bit aggressive and a nuisance when doing heavy
30# text edit cycles.
31# execute "export SPHINX_DEBUG=1" in your terminal to disable
32
33# The suffix of source filenames.
34source_suffix = '.rst'
35
36# The master toctree document.
37master_doc = 'index'
38
39# General information about the project.
40project = u'networking-spp'
41copyright = u'2017, OpenStack Developers'
42
43# openstackdocstheme options
44repository_name = 'openstack/networking-spp'
45bug_project = 'networking-spp'
46bug_tag = ''
47
48# If true, '()' will be appended to :func: etc. cross-reference text.
49add_function_parentheses = True
50
51# If true, the current module name will be prepended to all description
52# unit titles (such as .. function::).
53add_module_names = True
54
55# The name of the Pygments (syntax highlighting) style to use.
56pygments_style = 'sphinx'
57
58# -- Options for HTML output --------------------------------------------------
59
60# The theme to use for HTML and HTML Help pages. Major themes that come with
61# Sphinx are currently 'default' and 'sphinxdoc'.
62# html_theme_path = ["."]
63# html_theme = '_theme'
64# html_static_path = ['static']
65html_theme = 'openstackdocs'
66
67# Output file base name for HTML help builder.
68htmlhelp_basename = '%sdoc' % project
69
70# Grouping the document tree into LaTeX files. List of tuples
71# (source start file, target name, title, author, documentclass
72# [howto/manual]).
73latex_documents = [
74 ('index',
75 '%s.tex' % project,
76 u'%s Documentation' % project,
77 u'OpenStack Developers', 'manual'),
78]
79
80# Example configuration for intersphinx: refer to the Python standard library.
81#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst
new file mode 100644
index 0000000..bed0445
--- /dev/null
+++ b/doc/source/configuration/index.rst
@@ -0,0 +1,5 @@
1=============
2Configuration
3=============
4
5Configuration of networking-spp.
diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst
new file mode 100644
index 0000000..2aa0707
--- /dev/null
+++ b/doc/source/contributor/contributing.rst
@@ -0,0 +1,4 @@
1============
2Contributing
3============
4.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000..036e449
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,9 @@
1===========================
2 Contributor Documentation
3===========================
4
5.. toctree::
6 :maxdepth: 2
7
8 contributing
9
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..8a67f06
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,28 @@
1.. networking-spp documentation master file, created by
2 sphinx-quickstart on Tue Jul 9 22:26:36 2013.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6==============================================
7Welcome to the documentation of networking_spp
8==============================================
9
10Contents:
11
12.. toctree::
13 :maxdepth: 2
14
15 readme
16 install/index
17 library/index
18 contributor/index
19 configuration/index
20 user/index
21 reference/index
22
23Indices and tables
24==================
25
26* :ref:`genindex`
27* :ref:`modindex`
28* :ref:`search`
diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst
new file mode 100644
index 0000000..c929e4f
--- /dev/null
+++ b/doc/source/install/index.rst
@@ -0,0 +1,14 @@
1=========================================
2networking-spp service installation guide
3=========================================
4
5.. toctree::
6 :maxdepth: 2
7
8 install.rst
9
10The networking-spp service (networking_spp) provides...
11
12This chapter assumes a working setup of OpenStack following the
13`OpenStack Installation Tutorial
14<https://docs.openstack.org/project-install-guide/ocata/>`_.
diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst
new file mode 100644
index 0000000..87a210f
--- /dev/null
+++ b/doc/source/install/install.rst
@@ -0,0 +1,20 @@
1.. _install:
2
3Install and configure
4~~~~~~~~~~~~~~~~~~~~~
5
6This section describes how to install and configure the
7networking-spp service, code-named networking_spp, on the controller node.
8
9This section assumes that you already have a working OpenStack
10environment with at least the following components installed:
11.. (add the appropriate services here and further notes)
12
13Note that installation and configuration vary by distribution.
14
15.. toctree::
16 :maxdepth: 2
17
18 install-obs.rst
19 install-rdo.rst
20 install-ubuntu.rst
diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst
new file mode 100644
index 0000000..33d8f26
--- /dev/null
+++ b/doc/source/library/index.rst
@@ -0,0 +1,7 @@
1========
2Usage
3========
4
5To use networking-spp in a project::
6
7 import networking_spp
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
new file mode 100644
index 0000000..a6210d3
--- /dev/null
+++ b/doc/source/readme.rst
@@ -0,0 +1 @@
.. include:: ../../README.rst
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
new file mode 100644
index 0000000..b3f2528
--- /dev/null
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,5 @@
1==========
2References
3==========
4
5References of networking-spp.
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..d0813b1
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,5 @@
1===========
2Users guide
3===========
4
5Users guide of networking-spp.
diff --git a/networking_spp/__init__.py b/networking_spp/__init__.py
new file mode 100644
index 0000000..3ad25c8
--- /dev/null
+++ b/networking_spp/__init__.py
@@ -0,0 +1,19 @@
1# -*- coding: utf-8 -*-
2
3# Licensed under the Apache License, Version 2.0 (the "License"); you may
4# not use this file except in compliance with the License. You may obtain
5# a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12# License for the specific language governing permissions and limitations
13# under the License.
14
15import pbr.version
16
17
18__version__ = pbr.version.VersionInfo(
19 'networking-spp').version_string()
diff --git a/networking_spp/tests/__init__.py b/networking_spp/tests/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/networking_spp/tests/__init__.py
diff --git a/networking_spp/tests/base.py b/networking_spp/tests/base.py
new file mode 100644
index 0000000..1c30cdb
--- /dev/null
+++ b/networking_spp/tests/base.py
@@ -0,0 +1,23 @@
1# -*- coding: utf-8 -*-
2
3# Copyright 2010-2011 OpenStack Foundation
4# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
5#
6# Licensed under the Apache License, Version 2.0 (the "License"); you may
7# not use this file except in compliance with the License. You may obtain
8# a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15# License for the specific language governing permissions and limitations
16# under the License.
17
18from oslotest import base
19
20
21class TestCase(base.BaseTestCase):
22
23 """Test case base class for all unit tests."""
diff --git a/networking_spp/tests/test_networking_spp.py b/networking_spp/tests/test_networking_spp.py
new file mode 100644
index 0000000..bae640c
--- /dev/null
+++ b/networking_spp/tests/test_networking_spp.py
@@ -0,0 +1,28 @@
1# -*- coding: utf-8 -*-
2
3# Licensed under the Apache License, Version 2.0 (the "License"); you may
4# not use this file except in compliance with the License. You may obtain
5# a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12# License for the specific language governing permissions and limitations
13# under the License.
14
15"""
16test_networking_spp
17----------------------------------
18
19Tests for `networking_spp` module.
20"""
21
22from networking_spp.tests import base
23
24
25class TestNetworking_spp(base.TestCase):
26
27 def test_something(self):
28 pass
diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/releasenotes/notes/.placeholder
diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/releasenotes/source/_static/.placeholder
diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/releasenotes/source/_templates/.placeholder
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 0000000..14a29a5
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,280 @@
1# -*- coding: utf-8 -*-
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11# implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15# This file is execfile()d with the current directory set to its
16# containing dir.
17#
18# Note that not all possible configuration values are present in this
19# autogenerated file.
20#
21# All configuration values have a default; values that are commented out
22# serve to show the default.
23
24# If extensions (or modules to document with autodoc) are in another directory,
25# add these directories to sys.path here. If the directory is relative to the
26# documentation root, use os.path.abspath to make it absolute, like shown here.
27# sys.path.insert(0, os.path.abspath('.'))
28
29# -- General configuration ------------------------------------------------
30
31# If your documentation needs a minimal Sphinx version, state it here.
32# needs_sphinx = '1.0'
33
34# Add any Sphinx extension module names here, as strings. They can be
35# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36# ones.
37extensions = [
38 'openstackdocstheme',
39 'reno.sphinxext',
40]
41
42# Add any paths that contain templates here, relative to this directory.
43templates_path = ['_templates']
44
45# The suffix of source filenames.
46source_suffix = '.rst'
47
48# The encoding of source files.
49# source_encoding = 'utf-8-sig'
50
51# The master toctree document.
52master_doc = 'index'
53
54# General information about the project.
55project = u'networking_spp Release Notes'
56copyright = u'2017, OpenStack Developers'
57
58# openstackdocstheme options
59repository_name = 'openstack/networking-spp'
60bug_project = 'networking-spp'
61bug_tag = ''
62
63# The version info for the project you're documenting, acts as replacement for
64# |version| and |release|, also used in various other places throughout the
65# built documents.
66#
67# The short X.Y version.
68# The full version, including alpha/beta/rc tags.
69release = ''
70# The short X.Y version.
71version = ''
72
73# The language for content autogenerated by Sphinx. Refer to documentation
74# for a list of supported languages.
75# language = None
76
77# There are two options for replacing |today|: either, you set today to some
78# non-false value, then it is used:
79# today = ''
80# Else, today_fmt is used as the format for a strftime call.
81# today_fmt = '%B %d, %Y'
82
83# List of patterns, relative to source directory, that match files and
84# directories to ignore when looking for source files.
85exclude_patterns = []
86
87# The reST default role (used for this markup: `text`) to use for all
88# documents.
89# default_role = None
90
91# If true, '()' will be appended to :func: etc. cross-reference text.
92# add_function_parentheses = True
93
94# If true, the current module name will be prepended to all description
95# unit titles (such as .. function::).
96# add_module_names = True
97
98# If true, sectionauthor and moduleauthor directives will be shown in the
99# output. They are ignored by default.
100# show_authors = False
101
102# The name of the Pygments (syntax highlighting) style to use.
103pygments_style = 'sphinx'
104
105# A list of ignored prefixes for module index sorting.
106# modindex_common_prefix = []
107
108# If true, keep warnings as "system message" paragraphs in the built documents.
109# keep_warnings = False
110
111
112# -- Options for HTML output ----------------------------------------------
113
114# The theme to use for HTML and HTML Help pages. See the documentation for
115# a list of builtin themes.
116html_theme = 'openstackdocs'
117
118# Theme options are theme-specific and customize the look and feel of a theme
119# further. For a list of options available for each theme, see the
120# documentation.
121# html_theme_options = {}
122
123# Add any paths that contain custom themes here, relative to this directory.
124# html_theme_path = []
125
126# The name for this set of Sphinx documents. If None, it defaults to
127# "<project> v<release> documentation".
128# html_title = None
129
130# A shorter title for the navigation bar. Default is the same as html_title.
131# html_short_title = None
132
133# The name of an image file (relative to this directory) to place at the top
134# of the sidebar.
135# html_logo = None
136
137# The name of an image file (within the static path) to use as favicon of the
138# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
139# pixels large.
140# html_favicon = None
141
142# Add any paths that contain custom static files (such as style sheets) here,
143# relative to this directory. They are copied after the builtin static files,
144# so a file named "default.css" will overwrite the builtin "default.css".
145html_static_path = ['_static']
146
147# Add any extra paths that contain custom files (such as robots.txt or
148# .htaccess) here, relative to this directory. These files are copied
149# directly to the root of the documentation.
150# html_extra_path = []
151
152# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
153# using the given strftime format.
154# html_last_updated_fmt = '%b %d, %Y'
155
156# If true, SmartyPants will be used to convert quotes and dashes to
157# typographically correct entities.
158# html_use_smartypants = True
159
160# Custom sidebar templates, maps document names to template names.
161# html_sidebars = {}
162
163# Additional templates that should be rendered to pages, maps page names to
164# template names.
165# html_additional_pages = {}
166
167# If false, no module index is generated.
168# html_domain_indices = True
169
170# If false, no index is generated.
171# html_use_index = True
172
173# If true, the index is split into individual pages for each letter.
174# html_split_index = False
175
176# If true, links to the reST sources are added to the pages.
177# html_show_sourcelink = True
178
179# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
180# html_show_sphinx = True
181
182# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
183# html_show_copyright = True
184
185# If true, an OpenSearch description file will be output, and all pages will
186# contain a <link> tag referring to it. The value of this option must be the
187# base URL from which the finished HTML is served.
188# html_use_opensearch = ''
189
190# This is the file name suffix for HTML files (e.g. ".xhtml").
191# html_file_suffix = None
192
193# Output file base name for HTML help builder.
194htmlhelp_basename = 'networking_sppReleaseNotesdoc'
195
196
197# -- Options for LaTeX output ---------------------------------------------
198
199latex_elements = {
200 # The paper size ('letterpaper' or 'a4paper').
201 # 'papersize': 'letterpaper',
202
203 # The font size ('10pt', '11pt' or '12pt').
204 # 'pointsize': '10pt',
205
206 # Additional stuff for the LaTeX preamble.
207 # 'preamble': '',
208}
209
210# Grouping the document tree into LaTeX files. List of tuples
211# (source start file, target name, title,
212# author, documentclass [howto, manual, or own class]).
213latex_documents = [
214 ('index', 'networking_sppReleaseNotes.tex',
215 u'networking_spp Release Notes Documentation',
216 u'OpenStack Foundation', 'manual'),
217]
218
219# The name of an image file (relative to this directory) to place at the top of
220# the title page.
221# latex_logo = None
222
223# For "manual" documents, if this is true, then toplevel headings are parts,
224# not chapters.
225# latex_use_parts = False
226
227# If true, show page references after internal links.
228# latex_show_pagerefs = False
229
230# If true, show URL addresses after external links.
231# latex_show_urls = False
232
233# Documents to append as an appendix to all manuals.
234# latex_appendices = []
235
236# If false, no module index is generated.
237# latex_domain_indices = True
238
239
240# -- Options for manual page output ---------------------------------------
241
242# One entry per manual page. List of tuples
243# (source start file, name, description, authors, manual section).
244man_pages = [
245 ('index', 'networking_spprereleasenotes',
246 u'networking_spp Release Notes Documentation',
247 [u'OpenStack Foundation'], 1)
248]
249
250# If true, show URL addresses after external links.
251# man_show_urls = False
252
253
254# -- Options for Texinfo output -------------------------------------------
255
256# Grouping the document tree into Texinfo files. List of tuples
257# (source start file, target name, title, author,
258# dir menu entry, description, category)
259texinfo_documents = [
260 ('index', 'networking_spp ReleaseNotes',
261 u'networking_spp Release Notes Documentation',
262 u'OpenStack Foundation', 'networking_sppReleaseNotes',
263 'One line description of project.',
264 'Miscellaneous'),
265]
266
267# Documents to append as an appendix to all manuals.
268# texinfo_appendices = []
269
270# If false, no module index is generated.
271# texinfo_domain_indices = True
272
273# How to display URL addresses: 'footnote', 'no', or 'inline'.
274# texinfo_show_urls = 'footnote'
275
276# If true, do not generate a @detailmenu in the "Top" node's menu.
277# texinfo_no_detailmenu = False
278
279# -- Options for Internationalization output ------------------------------
280locale_dirs = ['locale/']
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 0000000..12cf4f7
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,8 @@
1============================================
2 networking_spp Release Notes
3============================================
4
5.. toctree::
6 :maxdepth: 1
7
8 unreleased
diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst
new file mode 100644
index 0000000..cd22aab
--- /dev/null
+++ b/releasenotes/source/unreleased.rst
@@ -0,0 +1,5 @@
1==============================
2 Current Series Release Notes
3==============================
4
5.. release-notes::
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..bf3e377
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,5 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4
5pbr>=2.0.0,!=2.1.0 # Apache-2.0
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..35f440a
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,47 @@
1[metadata]
2name = networking-spp
3summary = Neutron plugin for Soft Patch Panel
4description-file =
5 README.rst
6author = OpenStack
7author-email = openstack-dev@lists.openstack.org
8home-page = http://www.openstack.org/
9classifier =
10 Environment :: OpenStack
11 Intended Audience :: Information Technology
12 Intended Audience :: System Administrators
13 License :: OSI Approved :: Apache Software License
14 Operating System :: POSIX :: Linux
15 Programming Language :: Python
16 Programming Language :: Python :: 2
17 Programming Language :: Python :: 2.7
18 Programming Language :: Python :: 3
19 Programming Language :: Python :: 3.3
20 Programming Language :: Python :: 3.4
21
22[files]
23packages =
24 networking_spp
25
26[build_sphinx]
27all-files = 1
28warning-is-error = 1
29source-dir = doc/source
30build-dir = doc/build
31
32[upload_sphinx]
33upload-dir = doc/build/html
34
35[compile_catalog]
36directory = networking_spp/locale
37domain = networking_spp
38
39[update_catalog]
40domain = networking_spp
41output_dir = networking_spp/locale
42input_file = networking_spp/locale/networking_spp.pot
43
44[extract_messages]
45keywords = _ gettext ngettext l_ lazy_gettext
46mapping_file = babel.cfg
47output_file = networking_spp/locale/networking_spp.pot
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..056c16c
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,29 @@
1# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12# implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
17import setuptools
18
19# In python < 2.7.4, a lazy loading of package `pbr` will break
20# setuptools if some other modules registered functions in `atexit`.
21# solution from: http://bugs.python.org/issue15881#msg170215
22try:
23 import multiprocessing # noqa
24except ImportError:
25 pass
26
27setuptools.setup(
28 setup_requires=['pbr'],
29 pbr=True)
diff --git a/test-requirements.txt b/test-requirements.txt
new file mode 100644
index 0000000..6fc54cc
--- /dev/null
+++ b/test-requirements.txt
@@ -0,0 +1,15 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4
5hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
6
7coverage>=4.0,!=4.4 # Apache-2.0
8python-subunit>=0.0.18 # Apache-2.0/BSD
9sphinx>=1.6.2 # BSD
10oslotest>=1.10.0 # Apache-2.0
11stestr>=1.0.0 # Apache-2.0
12testtools>=1.4.0 # MIT
13openstackdocstheme>=1.17.0 # Apache-2.0
14# releasenotes
15reno>=2.5.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..f6ee3fc
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,50 @@
1[tox]
2minversion = 2.0
3envlist = py34,py27,pypy,pep8
4skipsdist = True
5
6[testenv]
7usedevelop = True
8install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
9setenv =
10 VIRTUAL_ENV={envdir}
11 PYTHONWARNINGS=default::DeprecationWarning
12 OS_STDOUT_CAPTURE=1
13 OS_STDERR_CAPTURE=1
14 OS_TEST_TIMEOUT=60
15deps = -r{toxinidir}/test-requirements.txt
16commands = stestr run {posargs}
17
18[testenv:pep8]
19commands = flake8 {posargs}
20
21[testenv:venv]
22commands = {posargs}
23
24[testenv:cover]
25setenv =
26 VIRTUAL_ENV={envdir}
27 PYTHON=coverage run --source networking_spp --parallel-mode
28commands =
29 stestr run {posargs}
30 coverage combine
31 coverage html -d cover
32 coverage xml -o cover/coverage.xml
33
34[testenv:docs]
35commands = python setup.py build_sphinx
36
37[testenv:releasenotes]
38commands =
39 sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
40
41[testenv:debug]
42commands = oslo_debug_helper {posargs}
43
44[flake8]
45# E123, E125 skipped as they are invalid PEP-8.
46
47show-source = True
48ignore = E123,E125
49builtins = _
50exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build