Skip to content

Commit cd0343c

Browse files
authored
Fixed the Acrolinx score
1 parent 6d3605a commit cd0343c

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

articles/cyclecloud/python-api.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ ms.author: rokeptne
88

99
# Python API
1010

11-
The CycleCloud Python API allows you to interact with the CycleCloud REST API without having to manually perform the HTTP requests. To acquire the API source distribution, navigate to */about* on your CycleCloud installation and click on the **Download Python API** link. Once you have the source distribution you can `pip install` it into your python environment and get started.
11+
The CycleCloud Python API allows you to interact with the CycleCloud REST API without having to manually perform the HTTP requests. To acquire the API source distribution, navigate to */about* on your CycleCloud installation and click on the **Download Python API** link. Once you have the source distribution, you can do `pip install` it into your python environment and get started.
1212

1313
## Client Objects
1414

15-
A Client object can be constructed with or without a configuration specified. If you don't specify a config dictionary it will automatically attempt to pull the configuration from the default CycleCloud CLI ini file (*~/.cycle/config.ini*).
15+
A Client object can be constructed with or without a configuration specified. If you don't specify a config dictionary it automatically attempts to pull the configuration from the default CycleCloud CLI ini file (*~/.cycle/config.ini*).
1616

1717
The configuration can be provided as a dict with the following key/value pairs:
1818

1919
- `url` - *required*, the url of the web interface to the CycleCloud installation
2020
- `username` - *required*
2121
- `password` - *required*, the plain text password of the user
22-
- `timeout` - the time, in seconds, before a timeout error will occur when attempting to connect/communicate with the system (60 by default)
22+
- `timeout` - the time, in seconds, before a timeout error occurs when attempting to connect/communicate with the system (60 by default)
2323
- `verify_certificates` - a boolean indicating whether certificate checking should be enabled (True by default)
2424

2525
Alternatively, these values can be given as keyword arguments to the constructor.
@@ -75,13 +75,13 @@ cluster_obj.scale_by_cores("execute", 5)
7575

7676
- `get_status(nodes=False)` - Gets a [Cluster Status](api.md#clusterstatus) object of the cluster, optionally populating the node list as well.
7777

78-
- `scale_by_cores(node_array, total_core_count)` - Sets the system to scale the specified node array to the desired total core count. If the node array already contains more than `total_core_count` cores then the call will have no effect.
78+
- `scale_by_cores(node_array, total_core_count)` - Sets the system to scale the specified node array to the desired total core count. If the node array already contains more than `total_core_count` cores, then the call has no effect.
7979

80-
- `scale_by_nodes(node_array, total_node_count)` - Sets the system to scale the specified node array to the desired total node count. If the node array already contains more than `total_node_count` nodes then the call will have no effect.
80+
- `scale_by_nodes(node_array, total_node_count)` - Sets the system to scale the specified node array to the desired total node count. If the node array already contains more than `total_node_count` nodes, then the call has no effect.
8181

8282
## Direct API
8383

84-
The rest API can be accessed in a more direct manner by using the api at `cyclecloud.api` and `cyclecloud.model` which is generated directly from the [REST API](api.md). To do so you simply construct a Client object and make calls using the `session` property provided on it.
84+
The rest API can be accessed in a more direct manner by using the API at `cyclecloud.api` and `cyclecloud.model` which is generated directly from the [REST API](api.md). To do so you construct a Client object and make calls using the `session` property provided on it.
8585

8686
```python
8787
from cyclecloud.client import Client
@@ -93,4 +93,3 @@ cl1 = Client()
9393
response_status, cluster_status = clusters.get_cluster_status(cl1.session, "test-cluster-1", nodes=False)
9494
print(cluster_status.state)
9595
```
96-

0 commit comments

Comments
 (0)