Browse Source

Initial cookiecutter commit

This commit establishes the test and
development environment for the cursive
repository.

Change-Id: I440c4c55172cddd194efafe5d8f8d18728d7f8c0
dane-fichter 2 years ago
parent
commit
0da0dd357d

+ 5
- 0
.gitignore View File

@@ -0,0 +1,5 @@
1
+*.egg*
2
+*.pyc
3
+*.placeholder
4
+.tox
5
+.testrepository/

+ 9
- 0
.testr.conf View File

@@ -0,0 +1,9 @@
1
+[DEFAULT]
2
+test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
3
+             OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
4
+             OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-160} \
5
+             ${PYTHON:-python} -m subunit.run discover -t ./ ${OS_TEST_PATH:-./cursive/tests} $LISTOPT $IDOPTION
6
+
7
+test_id_option=--load-list $IDFILE
8
+test_list_option=--list
9
+

+ 17
- 0
CONTRIBUTING.rst View File

@@ -0,0 +1,17 @@
1
+If you would like to contribute to the development of OpenStack, you must
2
+follow the steps in this page:
3
+
4
+   http://docs.openstack.org/infra/manual/developers.html
5
+
6
+If you already have a good understanding of how the system works and your
7
+OpenStack accounts are set up, you can skip to the development workflow
8
+section of this documentation to learn how changes to OpenStack should be
9
+submitted for review via the Gerrit tool:
10
+
11
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
12
+
13
+Pull requests submitted through GitHub will be ignored.
14
+
15
+Bugs should be filed on Launchpad, not GitHub:
16
+
17
+   https://bugs.launchpad.net/cursive

+ 4
- 0
HACKING.rst View File

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

+ 176
- 0
LICENSE View File

@@ -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
+

+ 6
- 0
MANIFEST.in View File

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

+ 19
- 0
README.rst View File

@@ -0,0 +1,19 @@
1
+===============================
2
+cursive
3
+===============================
4
+
5
+Cursive implements OpenStack-specific validation of digital signatures.
6
+
7
+As OpenStack continues to mature, robust security controls become increasingly
8
+critical. The cursive project contains code extracted from various OpenStack
9
+projects for verifying digital signatures. Additional capabilities will be
10
+added to this project in support of various security features.
11
+
12
+* Free software: Apache license
13
+* Source: http://git.openstack.org/cgit/openstack/cursive
14
+* Bugs: http://bugs.launchpad.net/cursive
15
+
16
+Features
17
+--------
18
+
19
+* TODO

+ 2
- 0
babel.cfg View File

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

+ 19
- 0
cursive/__init__.py View File

@@ -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
+
15
+import pbr.version
16
+
17
+
18
+__version__ = pbr.version.VersionInfo(
19
+    'cursive').version_string()

+ 0
- 0
cursive/tests/__init__.py View File


+ 22
- 0
cursive/tests/base.py View File

@@ -0,0 +1,22 @@
1
+# -*- coding: utf-8 -*-
2
+
3
+# Copyright 2010-2011 OpenStack Foundation
4
+#
5
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
6
+# not use this file except in compliance with the License. You may obtain
7
+# a copy of the License at
8
+#
9
+#      http://www.apache.org/licenses/LICENSE-2.0
10
+#
11
+# Unless required by applicable law or agreed to in writing, software
12
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14
+# License for the specific language governing permissions and limitations
15
+# under the License.
16
+
17
+from oslotest import base
18
+
19
+
20
+class TestCase(base.BaseTestCase):
21
+
22
+    """Test case base class for all unit tests."""

+ 28
- 0
cursive/tests/test_cursive.py View File

@@ -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
+"""
16
+test_cursive
17
+----------------------------------
18
+
19
+Tests for `cursive` module.
20
+"""
21
+
22
+from cursive.tests import base
23
+
24
+
25
+class TestCursive(base.TestCase):
26
+
27
+    def test_something(self):
28
+        pass

+ 75
- 0
doc/source/conf.py View File

@@ -0,0 +1,75 @@
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
+import os
16
+import sys
17
+
18
+sys.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.
23
+extensions = [
24
+    'sphinx.ext.autodoc',
25
+    #'sphinx.ext.intersphinx',
26
+    'oslosphinx'
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.
34
+source_suffix = '.rst'
35
+
36
+# The master toctree document.
37
+master_doc = 'index'
38
+
39
+# General information about the project.
40
+project = u'cursive'
41
+copyright = u'2016, OpenStack Foundation'
42
+
43
+# If true, '()' will be appended to :func: etc. cross-reference text.
44
+add_function_parentheses = True
45
+
46
+# If true, the current module name will be prepended to all description
47
+# unit titles (such as .. function::).
48
+add_module_names = True
49
+
50
+# The name of the Pygments (syntax highlighting) style to use.
51
+pygments_style = 'sphinx'
52
+
53
+# -- Options for HTML output --------------------------------------------------
54
+
55
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
56
+# Sphinx are currently 'default' and 'sphinxdoc'.
57
+# html_theme_path = ["."]
58
+# html_theme = '_theme'
59
+# html_static_path = ['static']
60
+
61
+# Output file base name for HTML help builder.
62
+htmlhelp_basename = '%sdoc' % project
63
+
64
+# Grouping the document tree into LaTeX files. List of tuples
65
+# (source start file, target name, title, author, documentclass
66
+# [howto/manual]).
67
+latex_documents = [
68
+    ('index',
69
+     '%s.tex' % project,
70
+     u'%s Documentation' % project,
71
+     u'OpenStack Foundation', 'manual'),
72
+]
73
+
74
+# Example configuration for intersphinx: refer to the Python standard library.
75
+#intersphinx_mapping = {'http://docs.python.org/': None}

+ 4
- 0
doc/source/contributing.rst View File

@@ -0,0 +1,4 @@
1
+============
2
+Contributing
3
+============
4
+.. include:: ../../CONTRIBUTING.rst

+ 25
- 0
doc/source/index.rst View File

@@ -0,0 +1,25 @@
1
+.. cursive 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
+Welcome to cursive's documentation!
7
+========================================================
8
+
9
+Contents:
10
+
11
+.. toctree::
12
+   :maxdepth: 2
13
+
14
+   readme
15
+   installation
16
+   usage
17
+   contributing
18
+
19
+Indices and tables
20
+==================
21
+
22
+* :ref:`genindex`
23
+* :ref:`modindex`
24
+* :ref:`search`
25
+

+ 12
- 0
doc/source/installation.rst View File

@@ -0,0 +1,12 @@
1
+============
2
+Installation
3
+============
4
+
5
+At the command line::
6
+
7
+    $ pip install cursive
8
+
9
+Or, if you have virtualenvwrapper installed::
10
+
11
+    $ mkvirtualenv cursive
12
+    $ pip install cursive

+ 1
- 0
doc/source/readme.rst View File

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

+ 7
- 0
doc/source/usage.rst View File

@@ -0,0 +1,7 @@
1
+========
2
+Usage
3
+========
4
+
5
+To use cursive in a project::
6
+
7
+    import cursive

+ 273
- 0
releasenotes/source/conf.py View File

@@ -0,0 +1,273 @@
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
+# Cursive Release Notes documentation build configuration file, created by
16
+# sphinx-quickstart on Tue Nov  3 17:40:50 2015.
17
+#
18
+# This file is execfile()d with the current directory set to its
19
+# containing dir.
20
+#
21
+# Note that not all possible configuration values are present in this
22
+# autogenerated file.
23
+#
24
+# All configuration values have a default; values that are commented out
25
+# serve to show the default.
26
+
27
+# If extensions (or modules to document with autodoc) are in another directory,
28
+# add these directories to sys.path here. If the directory is relative to the
29
+# documentation root, use os.path.abspath to make it absolute, like shown here.
30
+# sys.path.insert(0, os.path.abspath('.'))
31
+
32
+# -- General configuration ------------------------------------------------
33
+
34
+# If your documentation needs a minimal Sphinx version, state it here.
35
+# needs_sphinx = '1.0'
36
+
37
+# Add any Sphinx extension module names here, as strings. They can be
38
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39
+# ones.
40
+extensions = [
41
+    'oslosphinx',
42
+    'reno.sphinxext',
43
+]
44
+
45
+# Add any paths that contain templates here, relative to this directory.
46
+templates_path = ['_templates']
47
+
48
+# The suffix of source filenames.
49
+source_suffix = '.rst'
50
+
51
+# The encoding of source files.
52
+# source_encoding = 'utf-8-sig'
53
+
54
+# The master toctree document.
55
+master_doc = 'index'
56
+
57
+# General information about the project.
58
+project = u'cursive Release Notes'
59
+copyright = u'2016, OpenStack Foundation'
60
+
61
+# The version info for the project you're documenting, acts as replacement for
62
+# |version| and |release|, also used in various other places throughout the
63
+# built documents.
64
+#
65
+# The short X.Y version.
66
+# The full version, including alpha/beta/rc tags.
67
+release = ''
68
+# The short X.Y version.
69
+version = ''
70
+
71
+# The language for content autogenerated by Sphinx. Refer to documentation
72
+# for a list of supported languages.
73
+# language = None
74
+
75
+# There are two options for replacing |today|: either, you set today to some
76
+# non-false value, then it is used:
77
+# today = ''
78
+# Else, today_fmt is used as the format for a strftime call.
79
+# today_fmt = '%B %d, %Y'
80
+
81
+# List of patterns, relative to source directory, that match files and
82
+# directories to ignore when looking for source files.
83
+exclude_patterns = []
84
+
85
+# The reST default role (used for this markup: `text`) to use for all
86
+# documents.
87
+# default_role = None
88
+
89
+# If true, '()' will be appended to :func: etc. cross-reference text.
90
+# add_function_parentheses = True
91
+
92
+# If true, the current module name will be prepended to all description
93
+# unit titles (such as .. function::).
94
+# add_module_names = True
95
+
96
+# If true, sectionauthor and moduleauthor directives will be shown in the
97
+# output. They are ignored by default.
98
+# show_authors = False
99
+
100
+# The name of the Pygments (syntax highlighting) style to use.
101
+pygments_style = 'sphinx'
102
+
103
+# A list of ignored prefixes for module index sorting.
104
+# modindex_common_prefix = []
105
+
106
+# If true, keep warnings as "system message" paragraphs in the built documents.
107
+# keep_warnings = False
108
+
109
+
110
+# -- Options for HTML output ----------------------------------------------
111
+
112
+# The theme to use for HTML and HTML Help pages.  See the documentation for
113
+# a list of builtin themes.
114
+html_theme = 'default'
115
+
116
+# Theme options are theme-specific and customize the look and feel of a theme
117
+# further.  For a list of options available for each theme, see the
118
+# documentation.
119
+# html_theme_options = {}
120
+
121
+# Add any paths that contain custom themes here, relative to this directory.
122
+# html_theme_path = []
123
+
124
+# The name for this set of Sphinx documents.  If None, it defaults to
125
+# "<project> v<release> documentation".
126
+# html_title = None
127
+
128
+# A shorter title for the navigation bar.  Default is the same as html_title.
129
+# html_short_title = None
130
+
131
+# The name of an image file (relative to this directory) to place at the top
132
+# of the sidebar.
133
+# html_logo = None
134
+
135
+# The name of an image file (within the static path) to use as favicon of the
136
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
137
+# pixels large.
138
+# html_favicon = None
139
+
140
+# Add any paths that contain custom static files (such as style sheets) here,
141
+# relative to this directory. They are copied after the builtin static files,
142
+# so a file named "default.css" will overwrite the builtin "default.css".
143
+html_static_path = ['_static']
144
+
145
+# Add any extra paths that contain custom files (such as robots.txt or
146
+# .htaccess) here, relative to this directory. These files are copied
147
+# directly to the root of the documentation.
148
+# html_extra_path = []
149
+
150
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
151
+# using the given strftime format.
152
+# html_last_updated_fmt = '%b %d, %Y'
153
+
154
+# If true, SmartyPants will be used to convert quotes and dashes to
155
+# typographically correct entities.
156
+# html_use_smartypants = True
157
+
158
+# Custom sidebar templates, maps document names to template names.
159
+# html_sidebars = {}
160
+
161
+# Additional templates that should be rendered to pages, maps page names to
162
+# template names.
163
+# html_additional_pages = {}
164
+
165
+# If false, no module index is generated.
166
+# html_domain_indices = True
167
+
168
+# If false, no index is generated.
169
+# html_use_index = True
170
+
171
+# If true, the index is split into individual pages for each letter.
172
+# html_split_index = False
173
+
174
+# If true, links to the reST sources are added to the pages.
175
+# html_show_sourcelink = True
176
+
177
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
178
+# html_show_sphinx = True
179
+
180
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
181
+# html_show_copyright = True
182
+
183
+# If true, an OpenSearch description file will be output, and all pages will
184
+# contain a <link> tag referring to it.  The value of this option must be the
185
+# base URL from which the finished HTML is served.
186
+# html_use_opensearch = ''
187
+
188
+# This is the file name suffix for HTML files (e.g. ".xhtml").
189
+# html_file_suffix = None
190
+
191
+# Output file base name for HTML help builder.
192
+htmlhelp_basename = 'CursiveReleaseNotesdoc'
193
+
194
+
195
+# -- Options for LaTeX output ---------------------------------------------
196
+
197
+latex_elements = {
198
+    # The paper size ('letterpaper' or 'a4paper').
199
+    # 'papersize': 'letterpaper',
200
+
201
+    # The font size ('10pt', '11pt' or '12pt').
202
+    # 'pointsize': '10pt',
203
+
204
+    # Additional stuff for the LaTeX preamble.
205
+    # 'preamble': '',
206
+}
207
+
208
+# Grouping the document tree into LaTeX files. List of tuples
209
+# (source start file, target name, title,
210
+#  author, documentclass [howto, manual, or own class]).
211
+latex_documents = [
212
+    ('index', 'CursiveReleaseNotes.tex',
213
+     u'Cursive Release Notes Documentation',
214
+     u'Cursive Developers', 'manual'),
215
+]
216
+
217
+# The name of an image file (relative to this directory) to place at the top of
218
+# the title page.
219
+# latex_logo = None
220
+
221
+# For "manual" documents, if this is true, then toplevel headings are parts,
222
+# not chapters.
223
+# latex_use_parts = False
224
+
225
+# If true, show page references after internal links.
226
+# latex_show_pagerefs = False
227
+
228
+# If true, show URL addresses after external links.
229
+# latex_show_urls = False
230
+
231
+# Documents to append as an appendix to all manuals.
232
+# latex_appendices = []
233
+
234
+# If false, no module index is generated.
235
+# latex_domain_indices = True
236
+
237
+
238
+# -- Options for manual page output ---------------------------------------
239
+
240
+# One entry per manual page. List of tuples
241
+# (source start file, name, description, authors, manual section).
242
+man_pages = [
243
+    ('index', 'cursivereleasenotes', u'Cursive Release Notes Documentation',
244
+     [u'Cursive Developers'], 1)
245
+]
246
+
247
+# If true, show URL addresses after external links.
248
+# man_show_urls = False
249
+
250
+
251
+# -- Options for Texinfo output -------------------------------------------
252
+
253
+# Grouping the document tree into Texinfo files. List of tuples
254
+# (source start file, target name, title, author,
255
+#  dir menu entry, description, category)
256
+texinfo_documents = [
257
+    ('index', 'CursiveReleaseNotes', u'Cursive Release Notes Documentation',
258
+     u'Cursive Developers', 'CursiveReleaseNotes',
259
+     'One line description of project.',
260
+     'Miscellaneous'),
261
+]
262
+
263
+# Documents to append as an appendix to all manuals.
264
+# texinfo_appendices = []
265
+
266
+# If false, no module index is generated.
267
+# texinfo_domain_indices = True
268
+
269
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
270
+# texinfo_show_urls = 'footnote'
271
+
272
+# If true, do not generate a @detailmenu in the "Top" node's menu.
273
+# texinfo_no_detailmenu = False

+ 8
- 0
releasenotes/source/index.rst View File

@@ -0,0 +1,8 @@
1
+============================================
2
+ cursive Release Notes
3
+============================================
4
+
5
+.. toctree::
6
+   :maxdepth: 1
7
+
8
+   unreleased

+ 5
- 0
releasenotes/source/unreleased.rst View File

@@ -0,0 +1,5 @@
1
+==============================
2
+ Current Series Release Notes
3
+==============================
4
+
5
+.. release-notes::

+ 5
- 0
requirements.txt View File

@@ -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
+
5
+pbr>=1.6 # Apache-2.0

+ 51
- 0
setup.cfg View File

@@ -0,0 +1,51 @@
1
+[metadata]
2
+name = cursive
3
+summary = Cursive implements OpenStack-specific validation of digital signatures.
4
+description-file =
5
+    README.rst
6
+author = OpenStack
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
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]
23
+packages =
24
+    cursive
25
+
26
+[build_sphinx]
27
+source-dir = doc/source
28
+build-dir = doc/build
29
+all_files = 1
30
+
31
+[upload_sphinx]
32
+upload-dir = doc/build/html
33
+
34
+[compile_catalog]
35
+directory = cursive/locale
36
+domain = cursive
37
+
38
+[update_catalog]
39
+domain = cursive
40
+output_dir = cursive/locale
41
+input_file = cursive/locale/cursive.pot
42
+
43
+[extract_messages]
44
+keywords = _ gettext ngettext l_ lazy_gettext
45
+mapping_file = babel.cfg
46
+output_file = cursive/locale/cursive.pot
47
+
48
+[build_releasenotes]
49
+all_files = 1
50
+build-dir = releasenotes/build
51
+source-dir = releasenotes/source

+ 27
- 0
setup.py View File

@@ -0,0 +1,27 @@
1
+# Licensed under the Apache License, Version 2.0 (the "License");
2
+# you may not use this file except in compliance with the License.
3
+# You may obtain a copy of the License at
4
+#
5
+#    http://www.apache.org/licenses/LICENSE-2.0
6
+#
7
+# Unless required by applicable law or agreed to in writing, software
8
+# distributed under the License is distributed on an "AS IS" BASIS,
9
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10
+# implied.
11
+# See the License for the specific language governing permissions and
12
+# limitations under the License.
13
+
14
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
15
+import setuptools
16
+
17
+# In python < 2.7.4, a lazy loading of package `pbr` will break
18
+# setuptools if some other modules registered functions in `atexit`.
19
+# solution from: http://bugs.python.org/issue15881#msg170215
20
+try:
21
+    import multiprocessing  # noqa
22
+except ImportError:
23
+    pass
24
+
25
+setuptools.setup(
26
+    setup_requires=['pbr>=1.8'],
27
+    pbr=True)

+ 17
- 0
test-requirements.txt View File

@@ -0,0 +1,17 @@
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
+
5
+hacking<0.12,>=0.11.0 # Apache-2.0
6
+
7
+coverage>=3.6 # Apache-2.0
8
+python-subunit>=0.0.18 # Apache-2.0/BSD
9
+sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
10
+oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
11
+oslotest>=1.10.0 # Apache-2.0
12
+testrepository>=0.0.18 # Apache-2.0/BSD
13
+testscenarios>=0.4 # Apache-2.0/BSD
14
+testtools>=1.4.0 # MIT
15
+
16
+# releasenotes
17
+reno>=1.8.0 # Apache2

+ 64
- 0
tox.ini View File

@@ -0,0 +1,64 @@
1
+[tox]
2
+minversion = 2.0
3
+envlist = py34-constraints,py27-constraints,pep8-constraints
4
+skipsdist = True
5
+
6
+[testenv]
7
+usedevelop = True
8
+install_command =
9
+                  constraints: {[testenv:common-constraints]install_command}
10
+                  pip install -U {opts} {packages}
11
+setenv =
12
+   VIRTUAL_ENV={envdir}
13
+deps = -r{toxinidir}/test-requirements.txt
14
+commands = python setup.py testr --slowest --testr-args='{posargs}'
15
+
16
+[testenv:common-constraints]
17
+install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
18
+
19
+[testenv:pep8]
20
+commands = flake8 {posargs}
21
+
22
+[testenv:pep8-constraints]
23
+install_command = {[testenv:common-constraints]install_command}
24
+commands = flake8 {posargs}
25
+
26
+[testenv:venv]
27
+commands = {posargs}
28
+
29
+[testenv:venv-constraints]
30
+install_command = {[testenv:common-constraints]install_command}
31
+commands = {posargs}
32
+
33
+[testenv:cover]
34
+commands = python setup.py test --coverage --testr-args='{posargs}'
35
+
36
+[testenv:cover-constraints]
37
+install_command = {[testenv:common-constraints]install_command}
38
+commands = python setup.py test --coverage --testr-args='{posargs}'
39
+
40
+[testenv:docs]
41
+commands = python setup.py build_sphinx
42
+
43
+[testenv:releasenotes]
44
+commands =
45
+  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
46
+
47
+[testenv:docs-constraints]
48
+install_command = {[testenv:common-constraints]install_command}
49
+commands = python setup.py build_sphinx
50
+
51
+[testenv:debug]
52
+commands = oslo_debug_helper {posargs}
53
+
54
+[testenv:debug-constraints]
55
+install_command = {[testenv:common-constraints]install_command}
56
+commands = oslo_debug_helper {posargs}
57
+
58
+[flake8]
59
+# E123, E125 skipped as they are invalid PEP-8.
60
+
61
+show-source = True
62
+ignore = E123,E125
63
+builtins = _
64
+exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build

Loading…
Cancel
Save