skip to navigation
skip to content

Not Logged In

dio 0.3.2

Python API for DigitalOcean v2.0 REST API

Latest Version: 0.3.5

# Dio v0.3.2

##### 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"

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

""" Droplet backup options. Only needed for dio.Backup(options, droplet) """
options = {
"dev.example.com": {
"ssh_user" : "root",
"ssh_key" : "do_rsa",
"remote_dirs" : [
"/root", "/home", "/etc", "/src",
"/usr/local", "/usr/share", "/usr/bin",
"/usr/sbin", "/var/backups", "/var/mail",
"/var/log", "/var/www",
],
"excludes" : [ "man3", ],
"snapshot_hour" : 5,
"snapshots" : 5,
"use_ip" : True,
},
"production.example.com": {
"ssh_user" : "root",
"ssh_key" : "ssh_key",
"backup_dir" : "/Users/username/Droplets",
"remote_dirs" : [ "/var/www", "/etc/nginx" ],
"excludes" : [ "wpcf7_captcha", "cache" ],
"use_ip" : False,
"snapshot_hour" : 3,
"snapshots" : 7,
}
}


""" Backs up your droplets with rsync and does a daily snapshot """
for droplet in dio.Manager( token, ignore ).droplets:
dio.Backup( options, droplet )


```

--

### Changelog

#### v0.3.2
- added rsync excludes to options
- moved .token to .__token

#### v0.3.1
- version number bug in init

#### v0.3.0
- fixed bug in ssh_remote_dir check
- moved to a single src file
- even less api calls then before
- less ssh_remote_dir checks
- moved all class details() func to a @property
- backup log markdown improvements
- backup log lets you know if remote_dir does not exist

#### 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

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

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

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

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

#### 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.4
- removed auto droplet population from Manager.droplets

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

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

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

#### 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  
File Type Py Version Uploaded on Size
dio-0.3.2.tar.gz (md5) Source 2014-08-18 10KB
  • Downloads (All Versions):
  • 94 downloads in the last day
  • 489 downloads in the last week
  • 622 downloads in the last month
  • Author: Rob Johnson
  • Home Page: http://corndogcomputers.github.io/python-dio
  • Download URL: https://github.com/corndogcomputers/python-dio/tarball/master
  • Keywords: digitalocean,backup,vps,rsync,api
  • License:
    The MIT License (MIT)
    
    Copyright (c) 2014 Rob Johnson
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
  • Package Index Owner: corndogcomputers
  • DOAP record: dio-0.3.2.xml