Skip to content

Commit d74d6aa

Browse files
gtemagtema
committed
fix code style
1 parent 2d7f5e5 commit d74d6aa

113 files changed

Lines changed: 344 additions & 266 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.rst‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ toolstack. Covered are currently following items:
1414
* `python-openstacksdk`
1515
* `python-openstackclient`
1616

17-
The primary goal is to provide a possibility to use native OpenStack SDK and CLI with the OTC additional services
17+
The primary goal is to provide a possibility to use native OpenStack SDK and
18+
CLI with the OTC additional services
1819

1920
Getting Started
2021
===============
2122

22-
The very first step to get started is to install otcextensions into your system. For this please follow installation instructions_
23+
The very first step to get started is to install otcextensions into your
24+
system. For this please follow installation instructions_
2325

2426
.. _instructions: http://python-otcextensions.readthedocs.io/en/latest/install/index.html
2527

@@ -31,7 +33,8 @@ Configuration
3133
openstack.config
3234
================
3335

34-
The recommended way, since it is the most efficient way to configure both SDK and the CLI in one place
36+
The recommended way, since it is the most efficient way to configure both SDK
37+
and the CLI in one place
3538

3639
``openstack.config`` will find cloud configuration for as few as 1 clouds and
3740
as many as you want to put in a config file. It will read environment variables
@@ -68,19 +71,24 @@ in the following locations:
6871
* ``~/.config/openstack``
6972
* ``/etc/openstack``
7073

71-
AK/SK values required for access to some services (i.e. OBS) can be either configured as shown above in the clouds.yaml/secure.yaml,
72-
or they can be automatically retrieved from the S3_ACCESS_KEY_ID and S3_SECRET_ACCESS_KEY.
73-
Values from the clouds.yaml/secure.yaml take precedence over the ones from environment.
74+
AK/SK values required for access to some services (i.e. OBS) can be either
75+
configured as shown above in the clouds.yaml/secure.yaml, or they can be
76+
automatically retrieved from the S3_ACCESS_KEY_ID and S3_SECRET_ACCESS_KEY.
77+
Values from the clouds.yaml/secure.yaml take precedence over the ones from
78+
environment.
7479

75-
With this configuration you can start using openstackCLI simply ``openstack --os-cloud otc``
80+
With this configuration you can start using openstackCLI simply ``openstack
81+
--os-cloud otc``
7682

7783
More information at https://developer.openstack.org/sdks/python/openstacksdk/users/config
7884

7985
Old style way
8086
=============
8187

82-
The CLI can be configured via environment variables and command-line
83-
options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html or https://developer.openstack.org/sdks/python/openstacksdk/users/config.
88+
The CLI can be configured via environment variables and command-line options as
89+
listed in
90+
https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html
91+
or https://developer.openstack.org/sdks/python/openstacksdk/users/config.
8492

8593
Authentication using username/password is often used::
8694

‎doc/source/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Welcome to the OTC Extensions of the OpenStack SDK and CLI!
22
===========================================================
33

4-
**Note:** Currently documentation is a mostly a copy of OpenStackSDK documentation (used version).
4+
**Note:** Currently documentation is a mostly a copy of OpenStackSDK
5+
documentation (used version).
56
It will be soon extended with OTC services. Keep watching
67

78
This documentation is split into three sections:

‎doc/source/install/index.rst‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22
Installation
33
============
44

5-
Each OS version has it's own package names, versions, bugs. However there is a repository,
6-
which tries to address those issues (at least for RPM based distributions) - https://build.opensuse.org/project/show/Cloud:OTC:Tools:OpenStack.
7-
RPMs for most often used OSs are prepared and can be taken there.
5+
Each OS version has it's own package names, versions, bugs. However there is a
6+
repository, which tries to address those issues (at least for RPM based
7+
distributions) -
8+
https://build.opensuse.org/project/show/Cloud:OTC:Tools:OpenStack. RPMs for
9+
most often used OSs are prepared and can be taken there.
810

9-
With a pip package can be installed the following way (please remember, it is not the latest development state). At the command line::
11+
With a pip package can be installed the following way (please remember, it is
12+
not the latest development state). At the command line::
1013

1114
$ sudo yum install python-pip
1215
$ sudo pip install otcextensions --upgrade
@@ -18,18 +21,23 @@ Or, if you have virtualenv wrapper installed (more suitable for development)::
1821
$ pip install otcextensions
1922
$ python setup.py install
2023

21-
A more reliable and at the moment tested way is a "developer" approach with a latest state:
24+
A more reliable and at the moment tested way is a "developer" approach with a
25+
latest state:
2226

2327
The project could be installed following way:
2428

2529
* clone git repo
2630
* create virtual env `virtualenv venv && source vent/bin/activate`
27-
* install project dependencies into the virtualenv `pip install -r requirements.txt`
28-
* alternatively, instead of creating virtual env and installing requirements use tox venv manager `tox -e py36`
29-
* register CLI plugin using `python setup.py install_egg_info` or alternatively install project into venv `python setup.py install`
31+
* install project dependencies into the virtualenv `pip install -r
32+
requirements.txt`
33+
* alternatively, instead of creating virtual env and installing requirements
34+
use tox venv manager `tox -e py36`
35+
* register CLI plugin using `python setup.py install_egg_info` or alternatively
36+
install project into venv `python setup.py install`
3037

3138
Note
3239
====
3340

34-
Ensure you have pip package installed. In the CentOS it is for example `python-pip`,
35-
in Fedora it is better to use `python3` overall with `python3-pip`, `python3-virtualenv` (or `python3-tox`)
41+
Ensure you have pip package installed. In the CentOS it is for example
42+
`python-pip`, in Fedora it is better to use `python3` overall with
43+
`python3-pip`, `python3-virtualenv` (or `python3-tox`)

‎doc/source/user/guides/deh.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ A host can be allocated with a following snip.
6060
.. literalinclude:: ../examples/deh/create.py
6161
:pyobject: create_host
6262

63-
Allocating a DeH Host supports setting `quantity` parameter to allocate multiple
64-
hosts in a one call. Due to that the IDs of allocated hosts are being returned
65-
as part of the "virtual" resource in a `dedicated_host_ids` attribute
63+
Allocating a DeH Host supports setting `quantity` parameter to allocate
64+
multiple hosts in a one call. Due to that the IDs of allocated hosts are being
65+
returned as part of the "virtual" resource in a `dedicated_host_ids` attribute
6666

6767
Full example: `deh host create`_
6868

‎doc/source/user/index.rst‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Getting started with the OTCExtensions SDK
22
==========================================
33

44
Please note that OTCExtensions provides an extension to the OpenStackSDK.
5-
Please refer to it's documentation for the details <https://docs.openstack.org/python-openstacksdk/latest/>
5+
Please refer to it's documentation for the details <https://docs.openstack.org/openstacksdk/latest/>
66

77

88
Installation
@@ -28,19 +28,19 @@ approach, this is where you'll want to begin.
2828

2929
Plain-simple connect to OTC <guides/connect_otc>
3030
Configuration <config/index>
31-
Connect to an OpenStack Cloud Using a Config File <https://docs.openstack.org/python-openstacksdk/latest/user/guides/connect_from_config>
32-
Using Cloud Abstration Layer <https://docs.openstack.org/python-openstacksdk/latest/user/usage>
31+
Connect to an OpenStack Cloud Using a Config File <https://docs.openstack.org/openstacksdk/latest/user/guides/connect_from_config>
32+
Using Cloud Abstration Layer <https://docs.openstack.org/openstacksdk/latest/user/usage>
3333
Logging <guides/logging>
34-
Microversions <https://docs.openstack.org/python-openstacksdk/latest/user/microversions>
35-
Block Storage <https://docs.openstack.org/python-openstacksdk/latest/user/guides/block_storage>
36-
Compute <https://docs.openstack.org/python-openstacksdk/latest/user/guides/compute>
37-
Identity <https://docs.openstack.org/python-openstacksdk/latest/user/guides/identity>
38-
Image <https://docs.openstack.org/python-openstacksdk/latest/user/guides/image>
39-
Key Manager <https://docs.openstack.org/python-openstacksdk/latest/user/guides/key_manager>
40-
Message <https://docs.openstack.org/python-openstacksdk/latest/user/guides/message>
41-
Network <https://docs.openstack.org/python-openstacksdk/latest/user/guides/network>
42-
Object Store <https://docs.openstack.org/python-openstacksdk/latest/user/guides/object_store>
43-
Orchestration <https://docs.openstack.org/python-openstacksdk/latest/user/guides/orchestration>
34+
Microversions <https://docs.openstack.org/openstacksdk/latest/user/microversions>
35+
Block Storage <https://docs.openstack.org/openstacksdk/latest/user/guides/block_storage>
36+
Compute <https://docs.openstack.org/openstacksdk/latest/user/guides/compute>
37+
Identity <https://docs.openstack.org/openstacksdk/latest/user/guides/identity>
38+
Image <https://docs.openstack.org/openstacksdk/latest/user/guides/image>
39+
Key Manager <https://docs.openstack.org/openstacksdk/latest/user/guides/key_manager>
40+
Message <https://docs.openstack.org/openstacksdk/latest/user/guides/message>
41+
Network <https://docs.openstack.org/openstacksdk/latest/user/guides/network>
42+
Object Store <https://docs.openstack.org/openstacksdk/latest/user/guides/object_store>
43+
Orchestration <https://docs.openstack.org/openstacksdk/latest/user/guides/orchestration>
4444
RDS <guides/rds>
4545
OBS <guides/obs>
4646
AutoScaling <guides/auto_scaling>
@@ -50,7 +50,7 @@ approach, this is where you'll want to begin.
5050
API Documentation
5151
-----------------
5252

53-
OpenStackSDK documentation is available under <https://docs.openstack.org/python-openstacksdk/latest/user/index.html#api-documentation>
53+
OpenStackSDK documentation is available under <https://docs.openstack.org/openstacksdk/latest/user/index.html#api-documentation>
5454

5555

5656
Service APIs are exposed through a two-layered approach. The classes
@@ -101,20 +101,20 @@ control which services can be used.
101101
.. toctree::
102102
:maxdepth: 1
103103

104-
Block Storage <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/block_storage>
105-
Compute <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/compute>
106-
Database <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/database>
107-
Identity v2 <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/identity_v2>
108-
Identity v3 <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/identity_v3>
109-
Image v1 <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/image_v1>
110-
Image v2 <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/image_v2>
111-
Key Manager <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/key_manager>
112-
Load Balancer <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/load_balancer_v2>
113-
Message v2 <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/message_v2>
114-
Network <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/network>
115-
Object Store <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/object_store>
116-
Orchestration <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/orchestration>
117-
Workflow <https://docs.openstack.org/python-openstacksdk/latest/user/proxies/workflow>
104+
Block Storage <https://docs.openstack.org/openstacksdk/latest/user/proxies/block_storage>
105+
Compute <https://docs.openstack.org/openstacksdk/latest/user/proxies/compute>
106+
Database <https://docs.openstack.org/openstacksdk/latest/user/proxies/database>
107+
Identity v2 <https://docs.openstack.org/openstacksdk/latest/user/proxies/identity_v2>
108+
Identity v3 <https://docs.openstack.org/openstacksdk/latest/user/proxies/identity_v3>
109+
Image v1 <https://docs.openstack.org/openstacksdk/latest/user/proxies/image_v1>
110+
Image v2 <https://docs.openstack.org/openstacksdk/latest/user/proxies/image_v2>
111+
Key Manager <https://docs.openstack.org/openstacksdk/latest/user/proxies/key_manager>
112+
Load Balancer <https://docs.openstack.org/openstacksdk/latest/user/proxies/load_balancer_v2>
113+
Message v2 <https://docs.openstack.org/openstacksdk/latest/user/proxies/message_v2>
114+
Network <https://docs.openstack.org/openstacksdk/latest/user/proxies/network>
115+
Object Store <https://docs.openstack.org/openstacksdk/latest/user/proxies/object_store>
116+
Orchestration <https://docs.openstack.org/openstacksdk/latest/user/proxies/orchestration>
117+
Workflow <https://docs.openstack.org/openstacksdk/latest/user/proxies/workflow>
118118
Anti DDoS Service <proxies/anti_ddos>
119119
AutoScaling Service <proxies/auto_scaling>
120120
Cloud Container Engine v1<proxies/cce_v1>
@@ -147,19 +147,19 @@ classes.
147147
.. toctree::
148148
:maxdepth: 1
149149

150-
Baremetal <https://docs.openstack.org/python-openstacksdk/latest/user/resources/baremetal/index>
151-
Block Storage <https://docs.openstack.org/python-openstacksdk/latest/user/resources/block_storage/index>
152-
Clustering <https://docs.openstack.org/python-openstacksdk/latest/user/resources/clustering/index>
153-
Compute <https://docs.openstack.org/python-openstacksdk/latest/user/resources/compute/index>
154-
Database <https://docs.openstack.org/python-openstacksdk/latest/user/resources/database/index>
155-
Identity <https://docs.openstack.org/python-openstacksdk/latest/user/resources/identity/index>
156-
Image <https://docs.openstack.org/python-openstacksdk/latest/user/resources/image/index>
157-
Key Management <https://docs.openstack.org/python-openstacksdk/latest/user/resources/key_manager/index>
158-
Load Balancer <https://docs.openstack.org/python-openstacksdk/latest/user/resources/load_balancer/index>
159-
Network <https://docs.openstack.org/python-openstacksdk/latest/user/resources/network/index>
160-
Orchestration <https://docs.openstack.org/python-openstacksdk/latest/user/resources/orchestration/index>
161-
Object Store <https://docs.openstack.org/python-openstacksdk/latest/user/resources/object_store/index>
162-
Workflow <https://docs.openstack.org/python-openstacksdk/latest/user/resources/workflow/index>
150+
Baremetal <https://docs.openstack.org/openstacksdk/latest/user/resources/baremetal/index>
151+
Block Storage <https://docs.openstack.org/openstacksdk/latest/user/resources/block_storage/index>
152+
Clustering <https://docs.openstack.org/openstacksdk/latest/user/resources/clustering/index>
153+
Compute <https://docs.openstack.org/openstacksdk/latest/user/resources/compute/index>
154+
Database <https://docs.openstack.org/openstacksdk/latest/user/resources/database/index>
155+
Identity <https://docs.openstack.org/openstacksdk/latest/user/resources/identity/index>
156+
Image <https://docs.openstack.org/openstacksdk/latest/user/resources/image/index>
157+
Key Management <https://docs.openstack.org/openstacksdk/latest/user/resources/key_manager/index>
158+
Load Balancer <https://docs.openstack.org/openstacksdk/latest/user/resources/load_balancer/index>
159+
Network <https://docs.openstack.org/openstacksdk/latest/user/resources/network/index>
160+
Orchestration <https://docs.openstack.org/openstacksdk/latest/user/resources/orchestration/index>
161+
Object Store <https://docs.openstack.org/openstacksdk/latest/user/resources/object_store/index>
162+
Workflow <https://docs.openstack.org/openstacksdk/latest/user/resources/workflow/index>
163163
Anti DDoS Service <resources/anti_ddos/index>
164164
AutoScaling Service <resources/auto_scaling/index>
165165
DNS Service <resources/dns/index>

‎doc/source/user/proxies/auto_scaling.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ For details on how to use auto scaling, see :doc:`/user/guides/auto_scaling`
88
The AutoScaling Class
99
---------------------
1010

11-
The AS high-level interface is available through the ``auto_scaling``
12-
member of a :class:`~openstack.connection.Connection` object. The
13-
``auto_scaling`` member will only be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
11+
The AS high-level interface is available through the ``auto_scaling`` member of
12+
a :class:`~openstack.connection.Connection` object. The ``auto_scaling``
13+
member will only be added if the
14+
``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
1415

1516
Group Operations
1617
^^^^^^^^^^^^^^^^

‎doc/source/user/proxies/cce_v1.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ CCE API
66
The Cloud Container Engine Class
77
--------------------------------
88

9-
The cce high-level interface is available through the ``cce``
10-
member of a :class:`~openstack.connection.Connection` object. The
11-
``cce`` member will only be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
9+
The cce high-level interface is available through the ``cce`` member of a
10+
:class:`~openstack.connection.Connection` object. The ``cce`` member will only
11+
be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is
12+
called.
1213

1314
Cluster Operations
1415
^^^^^^^^^^^^^^^^^^

‎doc/source/user/proxies/cce_v3.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ CCE API
66
The Cloud Container Engine Class
77
--------------------------------
88

9-
The cce high-level interface is available through the ``cce``
10-
member of a :class:`~openstack.connection.Connection` object. The
11-
``cce`` member will only be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
9+
The cce high-level interface is available through the ``cce`` member of a
10+
:class:`~openstack.connection.Connection` object. The ``cce`` member will only
11+
be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is
12+
called.
1213

1314
Cluster Operations
1415
^^^^^^^^^^^^^^^^^^

‎doc/source/user/proxies/deh.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ DeH API
66
The Dedicated Host Service Class
77
--------------------------------
88

9-
The dehs high-level interface is available through the ``deh``
10-
member of a :class:`~openstack.connection.Connection` object. The
11-
``deh`` member will only be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
9+
The dehs high-level interface is available through the ``deh`` member of a
10+
:class:`~openstack.connection.Connection` object. The ``deh`` member will only
11+
be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is
12+
called.
1213

1314
Host Operations
1415
^^^^^^^^^^^^^^^

‎doc/source/user/proxies/dms.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ The Distributed Message Service Class
88

99
The dms high-level interface is available through the ``dms``
1010
member of a :class:`~openstack.connection.Connection` object. The
11-
``dms`` member will only be added if the ``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
11+
``dms`` member will only be added if the
12+
``otcextensions.sdk.register_otc_extensions(conn)`` method is called.
1213

1314
Queue Operations
1415
^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)