alejandrojnm / client-python

Python package to interact with Civo's API

Civo python API Library

This project is the python API library for using in python projects.

pip3 install civo

API Library

To use the library in your own python projects you can just add it to the requirements.txt:

civo

Install the package:

pip 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

Then you can use classes like this:

from civo import Civo

civo = Civo('token')
ssh_file = open('~/.ssh/id_dsa.pub').read()

# you can filter the result
size_id = civo.size.search(filter='name:g2.xsmall')[0]['name']
template = civo.templates.search(filter='code:debian-stretch')[0]['id']

civo.ssh.create(name='default', public_key=ssh_file)
civo.instances.create(hostname='text.example.com', size=size_id, 
                      region='lon1', template_id=template,
                      public_ip='true', ssh_key='default')

The API library consists of a handful of classes that implement the Civo API. There is full documentation on the API available at https://api.civo.com/doc/.