Skip to content

Commit e041824

Browse files
committed
setting up the initial layout; move the api proposals to api_strawman
Change-Id: I7c933d5e023c2a98a64aa90ed209f1e25d07f0d9
1 parent 73c11a1 commit e041824

30 files changed

+637
-34
lines changed

.coveragerc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[run]
2+
branch = True
3+
source = openstack
4+
omit = openstack/tests/*,openstack/openstack/*
5+
6+
[report]
7+
ignore-errors = True

.gitignore

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ develop-eggs
1717
.installed.cfg
1818
lib
1919
lib64
20-
__pycache__
2120

2221
# Installer logs
2322
pip-log.txt
@@ -26,6 +25,7 @@ pip-log.txt
2625
.coverage
2726
.tox
2827
nosetests.xml
28+
.testrepository
2929

3030
# Translations
3131
*.mo
@@ -34,3 +34,18 @@ nosetests.xml
3434
.mr.developer.cfg
3535
.project
3636
.pydevproject
37+
38+
# Complexity
39+
output/*.html
40+
output/*/index.html
41+
42+
# Sphinx
43+
doc/build
44+
45+
# pbr generates these
46+
AUTHORS
47+
ChangeLog
48+
49+
# Editors
50+
*~
51+
.*.swp

.mailmap

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Format is:
2+
# <preferred e-mail> <other e-mail 1>
3+
# <preferred e-mail> <other e-mail 2>

.testr.conf

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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

CONTRIBUTING.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
If you would like to contribute to the development of OpenStack,
2+
you must follow the steps in the "If you're a developer, start here"
3+
section of this page:
4+
5+
http://wiki.openstack.org/HowToContribute
6+
7+
Once those steps have been completed, changes to OpenStack
8+
should be submitted for review via the Gerrit tool, following
9+
the workflow documented at:
10+
11+
http://wiki.openstack.org/GerritWorkflow
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/python-openstacksdk

HACKING.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
python-openstacksdk Style Commandments
2+
===============================================
3+
4+
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

LICENSE

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
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.

MANIFEST.in

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include AUTHORS
2+
include ChangeLog
3+
exclude .gitignore
4+
exclude .gitreview
5+
6+
global-exclude *.pyc

README.rst

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,13 @@
1-
An OpenStack all-in-one SDK
2-
===========================
1+
===============================
2+
python-openstacksdk
3+
===============================
34

4-
Notes and mockups for a unified OpenStack SDK.
5+
OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package.
56

6-
Example:
7+
* Free software: Apache license
8+
* Documentation: http://docs.openstack.org/developer/python-openstacksdk
79

8-
.. code-block:: python
10+
Features
11+
--------
912

10-
import io
11-
12-
from openstack import OpenStackClient, KeystoneAuth
13-
14-
15-
client = OpenStackClient(KeystoneAuth('http://localhost:8000/', 'alex', '****'))
16-
image = client.compute.images.list()[0]
17-
server = client.compute.servers.create(image=image)
18-
print server.public_ips[0]
19-
20-
container = client.object_storage.containers.create(name='stuff')
21-
container.objects.create(name='a thing', contents=io.BytesIO(b'all the bytes'))
22-
23-
.. code-block:: python
24-
25-
import pystack
26-
from pystack.identity import KeystoneIdentity
27-
ident = KeystoneIdentity(username="ed", tenant_id="1234567890abcdef",
28-
password="******", auth_endpoint="http://123.123.123.123:5000/v2.0/")
29-
context = ident.authenticate()
30-
services_for_region = context.some_region
31-
compute_client = services_for_region.compute.client
32-
image = compute_client.list_images()[0]
33-
server = compute_client.create("server_name", image=image)
34-
35-
storage_client = services_for_region.object_storage.client
36-
container = storage_client.create("stuff")
37-
obj = container.create(file_or_path="/path/to/my/cool.jpg")
13+
* TODO

api_strawman/README.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
An OpenStack all-in-one SDK
2+
===========================
3+
4+
Notes and mockups for a unified OpenStack SDK.
5+
6+
Example:
7+
8+
.. code-block:: python
9+
10+
import io
11+
12+
from openstack import OpenStackClient, KeystoneAuth
13+
14+
15+
client = OpenStackClient(KeystoneAuth('http://localhost:8000/', 'alex', '****'))
16+
image = client.compute.images.list()[0]
17+
server = client.compute.servers.create(image=image)
18+
print server.public_ips[0]
19+
20+
container = client.object_storage.containers.create(name='stuff')
21+
container.objects.create(name='a thing', contents=io.BytesIO(b'all the bytes'))
22+
23+
.. code-block:: python
24+
25+
import pystack
26+
from pystack.identity import KeystoneIdentity
27+
ident = KeystoneIdentity(username="ed", tenant_id="1234567890abcdef",
28+
password="******", auth_endpoint="http://123.123.123.123:5000/v2.0/")
29+
context = ident.authenticate()
30+
services_for_region = context.some_region
31+
compute_client = services_for_region.compute.client
32+
image = compute_client.list_images()[0]
33+
server = compute_client.create("server_name", image=image)
34+
35+
storage_client = services_for_region.object_storage.client
36+
container = storage_client.create("stuff")
37+
obj = container.create(file_or_path="/path/to/my/cool.jpg")

0 commit comments

Comments
 (0)