Browse Source

Initial commit for the OSC metapackage repo.

Initial commit for OSC metapackage that includes all plugins.

Change-Id: I3db5eab671afada9b2cc026a4397ff9bdfdc0484
tags/0.1.0
Steve Martinelli 2 years ago
parent
commit
49b361d517
14 changed files with 834 additions and 0 deletions
  1. 45
    0
      .gitignore
  2. 7
    0
      .testr.conf
  3. 176
    0
      LICENSE
  4. 58
    0
      README.rst
  5. 136
    0
      doc/Makefile
  6. 246
    0
      doc/source/conf.py
  7. 32
    0
      doc/source/index.rst
  8. 18
    0
      requirements.txt
  9. 31
    0
      setup.cfg
  10. 29
    0
      setup.py
  11. 11
    0
      test-requirements.txt
  12. 0
    0
      tests/__init__.py
  13. 21
    0
      tests/test_openstackclient.py
  14. 24
    0
      tox.ini

+ 45
- 0
.gitignore View File

@@ -0,0 +1,45 @@
1
+*.py[cod]
2
+
3
+# Packages
4
+*.egg
5
+*.egg-info
6
+dist
7
+build
8
+eggs
9
+parts
10
+bin
11
+var
12
+sdist
13
+develop-eggs
14
+.installed.cfg
15
+lib
16
+lib64
17
+
18
+# Installer logs
19
+pip-log.txt
20
+
21
+# Unit test / coverage reports
22
+.coverage
23
+cover
24
+.tox
25
+nosetests.xml
26
+.testrepository
27
+
28
+# Developer
29
+.project
30
+.pydevproject
31
+
32
+# Complexity
33
+output/*.html
34
+output/*/index.html
35
+
36
+# Sphinx
37
+doc/build
38
+
39
+# pbr generates these
40
+AUTHORS
41
+ChangeLog
42
+
43
+# Editors
44
+*~
45
+.*.swp

+ 7
- 0
.testr.conf View File

@@ -0,0 +1,7 @@
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:-60} \
5
+             ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION
6
+test_id_option=--load-list $IDFILE
7
+test_list_option=--list

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

+ 58
- 0
README.rst View File

@@ -0,0 +1,58 @@
1
+===============
2
+OpenStackClient
3
+===============
4
+
5
+.. image:: https://img.shields.io/pypi/v/openstackclient.svg
6
+    :target: https://pypi.python.org/pypi/openstackclient/
7
+    :alt: Latest Version
8
+
9
+.. image:: https://img.shields.io/pypi/dm/openstackclient.svg
10
+    :target: https://pypi.python.org/pypi/openstackclient/
11
+    :alt: Downloads
12
+
13
+OpenStackClient (aka OSC) is a command-line client for OpenStack that brings
14
+the command set for Compute, Identity, Image, Object Store and Block Storage
15
+APIs together in a single shell with a uniform command structure.
16
+
17
+The primary goal is to provide a unified shell command structure and a common
18
+language to describe operations in OpenStack.
19
+
20
+* `PyPi`_ - package installation
21
+* `Online Documentation`_
22
+* `Launchpad project`_ - release management
23
+* `Blueprints`_ - feature specifications
24
+* `Bugs`_ - issue tracking
25
+* `Source`_
26
+* `Developer` - getting started as a developer
27
+* `Contributing` - contributing code
28
+* `Testing` - testing code
29
+* IRC: #openstack-sdks on Freenode (irc.freenode.net)
30
+* License: Apache 2.0
31
+
32
+.. _PyPi: https://pypi.python.org/pypi/openstackclient
33
+.. _Online Documentation: http://docs.openstack.org/developer/python-openstackclient/
34
+.. _Launchpad project: https://launchpad.net/python-openstackclient
35
+.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient
36
+.. _Bugs: https://bugs.launchpad.net/python-openstackclient
37
+.. _Source: https://git.openstack.org/cgit/openstack/openstackclient
38
+.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html
39
+.. _Contributing: http://docs.openstack.org/infra/manual/developers.html
40
+.. _Testing: http://docs.openstack.org/developer/python-openstackclient/developing.html#testing
41
+
42
+Getting Started
43
+===============
44
+
45
+OpenStack Client can be installed from PyPI using pip::
46
+
47
+    pip install openstackclient
48
+
49
+There are a few variants on getting help.  A list of global options and supported
50
+commands is shown with ``--help``::
51
+
52
+   openstack --help
53
+
54
+There is also a ``help`` command that can be used to get help text for a specific
55
+command::
56
+
57
+    openstack --help
58
+    openstack server create --help

+ 136
- 0
doc/Makefile View File

@@ -0,0 +1,136 @@
1
+# Makefile for Sphinx documentation
2
+#
3
+
4
+# You can set these variables from the command line.
5
+SPHINXOPTS    =
6
+SPHINXBUILD   = sphinx-build
7
+PAPER         =
8
+BUILDDIR      = build
9
+
10
+# Internal variables.
11
+PAPEROPT_a4     = -D latex_paper_size=a4
12
+PAPEROPT_letter = -D latex_paper_size=letter
13
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14
+
15
+.PHONY: help clean html pdf dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16
+
17
+help:
18
+	@echo "Please use \`make <target>' where <target> is one of"
19
+	@echo "  html       to make standalone HTML files"
20
+	@echo "  pdf        to make pdf with rst2pdf"
21
+	@echo "  dirhtml    to make HTML files named index.html in directories"
22
+	@echo "  singlehtml to make a single large HTML file"
23
+	@echo "  pickle     to make pickle files"
24
+	@echo "  json       to make JSON files"
25
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
26
+	@echo "  qthelp     to make HTML files and a qthelp project"
27
+	@echo "  devhelp    to make HTML files and a Devhelp project"
28
+	@echo "  epub       to make an epub"
29
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
30
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
31
+	@echo "  text       to make text files"
32
+	@echo "  man        to make manual pages"
33
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
34
+	@echo "  linkcheck  to check all external links for integrity"
35
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
36
+
37
+clean:
38
+	-rm -rf $(BUILDDIR)/*
39
+
40
+html:
41
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
42
+	@echo
43
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
44
+
45
+pdf:
46
+	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
47
+	@echo
48
+	@echo "Build finished. The PDFs are in $(BUILDDIR)/pdf."
49
+
50
+dirhtml:
51
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
52
+	@echo
53
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54
+
55
+singlehtml:
56
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
57
+	@echo
58
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
59
+
60
+pickle:
61
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
62
+	@echo
63
+	@echo "Build finished; now you can process the pickle files."
64
+
65
+json:
66
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
67
+	@echo
68
+	@echo "Build finished; now you can process the JSON files."
69
+
70
+htmlhelp:
71
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
72
+	@echo
73
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
74
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
75
+
76
+qthelp:
77
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
78
+	@echo
79
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
80
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
81
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NebulaDocs.qhcp"
82
+	@echo "To view the help file:"
83
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NebulaDocs.qhc"
84
+
85
+devhelp:
86
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
87
+	@echo
88
+	@echo "Build finished."
89
+	@echo "To view the help file:"
90
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/NebulaDocs"
91
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NebulaDocs"
92
+	@echo "# devhelp"
93
+
94
+epub:
95
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
96
+	@echo
97
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
98
+
99
+latex:
100
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101
+	@echo
102
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
103
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
104
+	      "(use \`make latexpdf' here to do that automatically)."
105
+
106
+latexpdf:
107
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108
+	@echo "Running LaTeX files through pdflatex..."
109
+	make -C $(BUILDDIR)/latex all-pdf
110
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
111
+
112
+text:
113
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
114
+	@echo
115
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
116
+
117
+man:
118
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
119
+	@echo
120
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
121
+
122
+changes:
123
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
124
+	@echo
125
+	@echo "The overview file is in $(BUILDDIR)/changes."
126
+
127
+linkcheck:
128
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
129
+	@echo
130
+	@echo "Link check complete; look for any errors in the above output " \
131
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
132
+
133
+doctest:
134
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
135
+	@echo "Testing of doctests in the sources finished, look at the " \
136
+	      "results in $(BUILDDIR)/doctest/output.txt."

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

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

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

@@ -0,0 +1,32 @@
1
+===============
2
+OpenStackClient
3
+===============
4
+
5
+OpenStackClient (aka OSC) is a command-line client for OpenStack that
6
+brings the command set for Compute, Identity, Image, Object Storage and
7
+Block Storage APIs together in a single shell with a uniform command
8
+structure.
9
+
10
+Getting Started
11
+---------------
12
+
13
+* Install OpenStackClient from `PyPi`_ or a `tarball`_
14
+
15
+Contributing
16
+============
17
+
18
+OpenStackClient utilizes all of the usual OpenStack processes and requirements for
19
+contributions.  The code is hosted `on OpenStack's Git server`_. `Bug reports`_
20
+and `blueprints`_ may be submitted to the ``openstackclient`` project
21
+on `Launchpad`_.  Code may be submitted to the
22
+``openstack/openstackclient`` project using `Gerrit`_.
23
+Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
24
+
25
+.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/openstackclient/tree
26
+.. _Launchpad: https://launchpad.net/python-openstackclient
27
+.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
28
+.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
29
+.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
30
+.. _PyPi: https://pypi.python.org/pypi/openstackclient
31
+.. _tarball: http://tarballs.openstack.org/openstackclient
32
+.. _IRC channel: https://wiki.openstack.org/wiki/IRC

+ 18
- 0
requirements.txt View File

@@ -0,0 +1,18 @@
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
+pbr>=1.8 # Apache-2.0
5
+aodhclient>=0.7.0 # Apache-2.0
6
+python-barbicanclient>=4.0.0 # Apache-2.0
7
+python-congressclient<2000,>=1.3.0 # Apache-2.0
8
+python-designateclient>=1.5.0 # Apache-2.0
9
+python-heatclient>=1.6.1 # Apache-2.0
10
+python-ironicclient>=1.6.0 # Apache-2.0
11
+python-ironic-inspector-client>=1.5.0 # Apache-2.0
12
+python-mistralclient>=2.0.0 # Apache-2.0
13
+python-muranoclient>=0.8.2 # Apache-2.0
14
+python-neutronclient>=5.1.0 # Apache-2.0
15
+python-saharaclient>=0.18.0 # Apache-2.0
16
+python-searchlightclient>=1.0.0 #Apache-2.0
17
+python-senlinclient>=0.3.0 # Apache-2.0
18
+python-zaqarclient>=1.0.0 # Apache-2.0

+ 31
- 0
setup.cfg View File

@@ -0,0 +1,31 @@
1
+[metadata]
2
+name = openstackclient
3
+summary = OpenStack Command-line Client
4
+description-file =
5
+    README.rst
6
+author = OpenStack
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://docs.openstack.org/developer/openstackclient
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.4
20
+    Programming Language :: Python :: 3.5
21
+
22
+[build_sphinx]
23
+source-dir = doc/source
24
+build-dir = doc/build
25
+all_files = 1
26
+
27
+[upload_sphinx]
28
+upload-dir = doc/build/html
29
+
30
+[pbr]
31
+warnerrors = true

+ 29
- 0
setup.py View File

@@ -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
17
+import 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
22
+try:
23
+    import multiprocessing  # noqa
24
+except ImportError:
25
+    pass
26
+
27
+setuptools.setup(
28
+    setup_requires=['pbr>=1.8'],
29
+    pbr=True)

+ 11
- 0
test-requirements.txt View File

@@ -0,0 +1,11 @@
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
+hacking<0.11,>=0.10.0
5
+
6
+# this is required for the tests
7
+oslotest>=1.10.0 # Apache-2.0
8
+
9
+# this is required for the docs
10
+sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
11
+oslosphinx>=4.7.0 # Apache-2.0

+ 0
- 0
tests/__init__.py View File


+ 21
- 0
tests/test_openstackclient.py View File

@@ -0,0 +1,21 @@
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
+from oslotest import base
16
+
17
+
18
+class TestOpenstackClient(base.BaseTestCase):
19
+
20
+    def test_something(self):
21
+        pass

+ 24
- 0
tox.ini View File

@@ -0,0 +1,24 @@
1
+[tox]
2
+minversion = 1.6
3
+envlist = py35,py27,pep8
4
+
5
+[testenv]
6
+deps = -r{toxinidir}/test-requirements.txt
7
+commands = python setup.py testr --slowest --testr-args='{posargs}'
8
+
9
+[testenv:pep8]
10
+deps=-r{toxinidir}/test-requirements.txt
11
+commands =
12
+  flake8
13
+
14
+[testenv:venv]
15
+commands = {posargs}
16
+
17
+[testenv:docs]
18
+commands = python setup.py build_sphinx
19
+
20
+[flake8]
21
+ignore = E123,H405
22
+show-source = True
23
+exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,__init__.py
24
+

Loading…
Cancel
Save