Skip to content

Commit d17187a

Browse files
committed
Update README.md Formatting
1 parent 43a62a9 commit d17187a

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -70,51 +70,51 @@ Initialize the `Vultr` class with your API Key or use the `VULTR_API_KEY` enviro
7070
```python
7171
from vultr import Vultr
7272

73-
vultr = Vultr('VULTR_API_KEY')
73+
vultr = Vultr("VULTR_API_KEY")
7474
```
7575

7676
List plans and get available regions for that plan
7777

7878
```python
79-
plans = vultr.list_plans({'type': 'vc2'}) # Filter by type
79+
plans = vultr.list_plans({"type": "vc2"}) # Filter by type
8080
plan = plans[0] # 0 seems to be the base plan
8181
regions = vultr.list_regions()
82-
available = vultr.filter_regions(regions, plan['locations'])
82+
available = vultr.filter_regions(regions, plan["locations"])
8383
```
8484

8585
Get the OS list and filter by name
8686

8787
```python
8888
os_list = vultr.list_os()
89-
ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 24.04 LTS x64')
89+
ubuntu_lts = vultr.filter_os(os_list, "Ubuntu 24.04 LTS x64")
9090
```
9191

9292
Create a new ssh key from key string
9393

9494
```python
95-
sshkey = vultr.create_key('key-name', 'ssh-rsa AAAA...')
95+
sshkey = vultr.create_key("key-name", "ssh-rsa AAAA...")
9696
```
9797

9898
Create a new instance
9999

100100
```python
101101
data = {
102-
'os_id': ubuntu_lts['id'],
103-
'sshkey_id': [sshkey['id']],
104-
'hostname': 'my-new-host',
105-
'label': 'my-new-host',
102+
"os_id": ubuntu_lts["id"],
103+
"sshkey_id": [sshkey["id"]],
104+
"hostname": "my-new-host",
105+
"label": "my-new-host",
106106
}
107107
instance = vultr.create_instance(available[0], plan, **data)
108108
```
109109

110110
Arbitrary Methods `get`, `post`, `patch`, `put`, `delete`
111111

112112
```python
113-
plans = vultr.get('plans', {'type': 'vc2'})
114-
sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
115-
instance = vultr.patch('instances', plan=plans[1]['id'])
116-
instance = vultr.patch('blocks/{block-id}', plan=plans[1]['id'])
117-
vultr.delete("instances/{instance-id}")
113+
plans = vultr.get("/plans", {"type": "vc2"})
114+
sshkey = vultr.post("/ssh-keys", name="key-name", ssh_key="ssh-rsa AAAA...")
115+
instance = vultr.patch("/instances", plan=plans[1]["id"])
116+
database = vultr.put("/databases/{database-id}", tag="new tag")
117+
vultr.delete("/snapshots/{snapshot-id}")
118118
```
119119

120120
Error Handling

docs/index.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,51 +48,51 @@ Initialize the `Vultr` class with your API Key or use the `VULTR_API_KEY` enviro
4848
```python
4949
from vultr import Vultr
5050

51-
vultr = Vultr('VULTR_API_KEY')
51+
vultr = Vultr("VULTR_API_KEY")
5252
```
5353

5454
List plans and get available regions for that plan
5555

5656
```python
57-
plans = vultr.list_plans({'type': 'vc2'}) # Filter by type
57+
plans = vultr.list_plans({"type": "vc2"}) # Filter by type
5858
plan = plans[0] # 0 seems to be the base plan
5959
regions = vultr.list_regions()
60-
available = vultr.filter_regions(regions, plan['locations'])
60+
available = vultr.filter_regions(regions, plan["locations"])
6161
```
6262

6363
Get the OS list and filter by name
6464

6565
```python
6666
os_list = vultr.list_os()
67-
ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 24.04 LTS x64')
67+
ubuntu_lts = vultr.filter_os(os_list, "Ubuntu 24.04 LTS x64")
6868
```
6969

7070
Create a new ssh key from key string
7171

7272
```python
73-
sshkey = vultr.create_key('key-name', 'ssh-rsa AAAA...')
73+
sshkey = vultr.create_key("key-name", "ssh-rsa AAAA...")
7474
```
7575

7676
Create a new instance
7777

7878
```python
7979
data = {
80-
'os_id': ubuntu_lts['id'],
81-
'sshkey_id': [sshkey['id']],
82-
'hostname': 'my-new-host',
83-
'label': 'my-new-host',
80+
"os_id": ubuntu_lts["id"],
81+
"sshkey_id": [sshkey["id"]],
82+
"hostname": "my-new-host",
83+
"label": "my-new-host",
8484
}
8585
instance = vultr.create_instance(available[0], plan, **data)
8686
```
8787

8888
Arbitrary Methods [get](#Vultr.get), [post](#Vultr.post), [patch](#Vultr.patch), [put](#Vultr.put), [delete](#Vultr.delete)
8989

9090
```python
91-
plans = vultr.get('plans', {'type': 'vc2'})
92-
sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
93-
instance = vultr.patch('instances', plan=plans[1]['id'])
94-
instance = vultr.patch('blocks/{block-id}', plan=plans[1]['id'])
95-
vultr.delete("instances/{instance-id}")
91+
plans = vultr.get("/plans", {"type": "vc2"})
92+
sshkey = vultr.post("/ssh-keys", name="key-name", ssh_key="ssh-rsa AAAA...")
93+
instance = vultr.patch("/instances", plan=plans[1]["id"])
94+
database = vultr.put("/databases/{database-id}", tag="new tag")
95+
vultr.delete("/snapshots/{snapshot-id}")
9696
```
9797

9898
Error Handling

0 commit comments

Comments
 (0)