Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cssnr/vultr-python
Python 3 wrapper for the Vultr API v2 Docs: https://cssnr.github.io/vultr-python
https://github.com/cssnr/vultr-python
python vultr
Last synced: 2 months ago
JSON representation
Python 3 wrapper for the Vultr API v2 Docs: https://cssnr.github.io/vultr-python
- Host: GitHub
- URL: https://github.com/cssnr/vultr-python
- Owner: cssnr
- Created: 2021-12-23T23:05:00.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-31T08:30:01.000Z (over 1 year ago)
- Last Synced: 2024-09-14T22:47:52.266Z (4 months ago)
- Topics: python, vultr
- Language: Python
- Homepage: https://www.vultr.com/?ref=6905748
- Size: 10.7 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://discord.gg/wXy6m2X8wY)
[](https://app.codacy.com/gh/cssnr/vultr-python/dashboard)
[](https://pypi.org/project/vultr-python/)
[](https://www.vultr.com/?ref=6905748)
# Vultr Python
Python 3 wrapper for the Vultr API v2.
* Vultr: [https://www.vultr.com](https://www.vultr.com/?ref=6905748)
* Vultr API: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
* Vultr Python Docs: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)
This is currently a WIP and not complete, but has some useful functions.
Feel free to request additional functions and more on [Discord](https://discord.gg/wXy6m2X8wY).
## Install
From PyPi using pip:
```text
python -m pip install vultr-python
```
From Source using setuptools:
```text
git clone https://github.com/cssnr/vultr-python.git
cd vultr-python
python setup.py install
```
## Usage
You will need to create an api key and whitelist your IP address.
Most functions do not work without an API Key.
* [https://my.vultr.com/settings/#settingsapi](https://my.vultr.com/settings/#settingsapi)
Initialize the class with your API Key or with the `VULTR_API_KEY` environment variable.
```python
from vultr import Vultr
vultr = Vultr('VULTR_API_KEY')
```
List plans and get available regions for that plan
```python
plans = vultr.list_plans()
plan = plans[0] # 0 seems to be the basic 5 dollar plan
regions = vultr.list_regions()
available = vultr.filter_regions(regions, plan['locations'])
```
Get the OS list and filter by name
```python
os_list = vultr.list_os()
ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 20.04 x64')
```
Create a new ssh key from key string
```python
sshkey = vultr.create_key('key-name', 'ssh-rsa AAAA...')
```
Create a new instance
```python
hostname = 'my-new-host'
data = {
'region': available[0]['id'],
'plan': plan['id'],
'os_id': ubuntu_lts['id'],
'sshkey_id': [sshkey['id']],
'hostname': hostname,
'label': hostname,
}
instance = vultr.create_instance(**data)
```
View all functions at the Doc site: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)
View the full API documentation at Vultr: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)
If you have more questions, concerns, or comments? Join our [Discord](https://discord.gg/wXy6m2X8wY) for more information...