Skip to main content
# Dio v0.2.10

##### Python API for DigitalOcean v2.0 REST API

### How to install

You can install dio using **pip**

pip install -U dio

or via sources:

python setup.py install

--

### Features
* **DROPLET BACKUP!!! (rsync and snapshot a droplet)**
* **Uses digitalocean v2.0 API**
* Running API call count
* Running API remaining call count
* All objects have a details function to return properties and values
* Get user's Droplets
* Get user's Images (Snapshot and Backups)
* Get public Images
* Create and Remove a Droplet
* Resize a Droplet
* Shutdown, restart and boot a Droplet
* Power off, power on and "power cycle" a Droplet
* Perform Snapshot
* Enable/Disable automatic Backups
* Restore root password of a Droplet

--

### Example cronjob:

```sh
# DigitalOcean backup script
0 * * * * /usr/bin/python /Users/username/bin/backup.py
```

--

### Example backup script:

```python

import dio

""" Your digitalocean API v2.0 token """
token = "YOUR_TOKEN"

""" Ignore list of droplets to bypass in operations """
ignore = ["dev.example.com"]

""" Droplet backup options. Only needed when doing backup """
options = {
"dev.example.com": {
"ssh_user" : "root",
"ssh_key" : "ssh_key",
"backup_dir" : "/Users/username/Droplets",
"remote_dirs" : [ "/root", "/var/log/apt" ],
"use_ip" : True,
"snapshot_hour" : 3,
"snapshots_keep" : 2,
"snapshot_delete" : True,
},
"production.example.com": {
"ssh_user" : "root",
"ssh_key" : "ssh_key",
"backup_dir" : "/Users/username/Droplets",
"remote_dirs" : [ "/var/www", "/etc/nginx" ],
"use_ip" : True,
"snapshot_hour" : 3,
"snapshots_keep" : 7,
"snapshot_delete" : True,
}
}

manager = dio.Manager( token, ignore )

""" backup your droplets with rsync """
for droplet in manager.get_all_droplets():
dio.Backup( options, droplet )
""" creates a backup log in your backup folder """

""" See how many api calls you used """
print dio.api.calls

""" See how many remaining api calls you have left for the hour """
print dio.api.remaining

```

--

### Changelog

#### v0.1
- pypi "python-dio" package was deleted.

#### v0.2
- added full backup function to Backup.py class.
- added backup prompt for Droplet.delete(). Pass in False to bypass prompt
- renamed package from python-dio to dio

#### v0.2.1
- added check to Backup.rsync() to make sure the droplet is on

#### v0.2.2
- changed Droplet.snapshot() to use shutdown instead of power_off.

#### v0.2.3
- hidden token from .details() data

#### v0.2.4
- removed auto droplet population from Manager.droplets

#### v0.2.5
- fixed delete backup snapshot to only delete snapshots created by backup
- fixed manager.get_all_images() to get paginated results
- changed backup option remote_dir to remote_dirs[] so you can rsync multiple directories
- better backup logging

#### v0.2.6
- changed backup log to markdown

#### v0.2.7
- removed log entries for empty rsync

#### v0.2.8
- better support for github flavored markdown in backup log

#### v0.2.9
- fixed variable bug in backup

#### v0.2.10
- better backup time in log
- changed droplet.snapshot to not start with "@"
- backup droplet.snapshot starts with "@"
- code cleanup for Backup.py
- added @properties to Manager and Droplet for lazy instantiation
- uses even less api calls

--

Designed to be compatible with [python-digitalocean](https://github.com/koalalorenzo/python-digitalocean)

Metadata

Release files for dio 0.2.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dio 0.2.10
File Size Uploaded
dio-0.2.10.tar.gz 11.7 kB Details

Release files / dio-0.2.10.tar.gz

Download URL dio-0.2.10.tar.gz
Size 11.7 kB
Tags Source
SHA-256 checksum
How to use checksums
670f3e0a25e54058ff88d4af9b45a47c814e8e0243dbab30d473467a76cfacc4
BLAKE2b-256 checksum
How to use checksums
9dc24d2b3030059748288df52d10f42d8e2854728fafa4ac6632d7b857789d5d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.3.10

1 release file

0.3.9

1 release file

0.3.8

1 release file

0.3.7

1 release file

0.3.6

1 release file

0.3.5

1 release file

0.3.4

1 release file

0.3.3

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

This release

0.2.10 This release

1 release file

0.2.9

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page