This project is the python API library for using in python projects.
pip3 install civo
To use the library in your own python projects you can just add it to the requirements.txt:
civo
Install the package:
pip3 install civo
You need to define CIVO_TOKEN
in the environment or when you create a instance of civo
you can pass the token as param,
also you can change the api endpoint adding to the environment CIVO_API
by default we use api.civo.com
Regions:
- CIVO only supports IaaS in its SVG1 region
- The API will default to the NYC1 region, override it with the region option when you create an instance of
Civo
Usage:
from civo import Civo
from os.path import expanduser
civo = Civo('token', region='SVG1')
home = expanduser("~/.ssh/")
ssh_file = open('{}id_dsa.pub'.format(home)).read()
# you can filter the result
size_id = civo.size.search(filter_by='name:g2.xsmall')[0]['name']
template = civo.templates.search(filter_by='code:debian-stretch')[0]['id']
civo.ssh.create(name='default', public_key=ssh_file)
ssh_id = civo.ssh.search(filter_by='name:default')[0]['id']
civo.instances.create(hostname='text.example.com', size=size_id, template_id=template, public_ip='true', ssh_key=ssh_id)
Create a new Kubernetes Cluster in the NYC1 DC
from civo import Civo
civo = Civo('token', region='NYC1')
civo.kubernetes.create(name='my_cluster', num_nodes=2)
The API library consists of a handful of classes that implement the Civo API. There is full documentation on the API available at https://www.civo.com/api.