Easy access to Digital Ocean APIs to deploy droplets, images and more.
- How to install
- Configurations
- Features
- Examples
- Listing the droplets
- Listing the droplets by tags
- Add a tag to a droplet
- Shutdown all droplets
- Creating a Droplet and checking its status
- Checking the status of the droplet
- Add SSHKey into DigitalOcean Account
- Creating a new droplet with all your SSH keys
- Creating a Firewall
- Listing the domains
- Listing records of a domain
- Creating a domain record
- Update a domain record
- Getting account requests/hour limits status
- Session customization
- Testing
- Links
You can install python-digitalocean using pip
pip install -U python-digitalocean
or via sources:
python setup.py install
Specify a custom provider using environment variable
export DIGITALOCEAN_END_POINT=http://example.com/
Specify the DIGITALOCEAN_ACCESS_TOKEN using environment variable
export DIGITALOCEAN_ACCESS_TOKEN='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Note: Probably want to add the export line above to your .bashrc file.
python-digitalocean support all the features provided via digitalocean.com APIs, such as:
- Get user's Droplets
- Get user's Images (Snapshot and Backups)
- Get public Images
- Get Droplet's event status
- Create and Remove a Droplet
- Create, Add and Remove Tags from Droplets
- 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
This example shows how to list all the active droplets:
import digitalocean
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
my_droplets = manager.get_all_droplets()
print(my_droplets)This example shows how to specify custom provider's end point URL:
import digitalocean
manager = digitalocean.Manager(token="secretspecialuniquesnowflake", end_point="http://example.com/")This example shows how to list all the active droplets:
import digitalocean
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
my_droplets = manager.get_all_droplets(tag_name="awesome")
print(my_droplets)This example shows how to add a tag to a droplet:
import digitalocean
tag = digitalocean.Tag(token="secretspecialuniquesnowflake", name="tag_name")
tag.create() # create tag if not already created
tag.add_droplets(["DROPLET_ID"])This example shows how to shutdown all the active droplets:
import digitalocean
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
my_droplets = manager.get_all_droplets()
for droplet in my_droplets:
droplet.shutdown()This example shows how to create a droplet and how to check its status
import digitalocean
droplet = digitalocean.Droplet(token="secretspecialuniquesnowflake",
name='Example',
region='nyc2', # New York 2
image='ubuntu-14-04-x64', # Ubuntu 14.04 x64
size_slug='512mb', # 512MB
backups=True)
droplet.create()actions = droplet.get_actions()
for action in actions:
action.load()
# Once it shows complete, droplet is up and running
print action.statusfrom digitalocean import SSHKey
user_ssh_key = open('/home/<$USER>/.ssh/id_rsa.pub').read()
key = SSHKey(token='secretspecialuniquesnowflake',
name='uniquehostname',
public_key=user_ssh_key)
key.create()manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
keys = manager.get_all_sshkeys()
droplet = digitalocean.Droplet(token="secretspecialuniquesnowflake",
name='DropletWithSSHKeys',
region='ams3', # Amster
image='ubuntu-14-04-x64', # Ubuntu 14.04 x64
size_slug='512mb', # 512MB
ssh_keys=keys, #Automatic conversion
backups=False)
droplet.create()This example creates a firewall that only accepts inbound tcp traffic on port 80 from a specific load balancer and allows outbout tcp traffic on all ports to all addresses.
from digitalocean import Firewall, InboundRule, OutboundRule, Destinations, Sources
inbound_rule = InboundRule(protocol="tcp", ports="80",
sources=Sources(
load_balancer_uids=[
"4de7ac8b-495b-4884-9a69-1050c6793cd6"]
)
)
outbound_rule = OutboundRule(protocol="tcp", ports="all",
destinations=Destinations(
addresses=[
"0.0.0.0/0",
"::/0"]
)
)
firewall = Firewall(token="secretspecialuniquesnowflake",
name="new-firewall",
inbound_rules=[inbound_rule],
outbound_rules=[outbound_rule],
droplet_ids=[8043964, 8043972])
firewall.create()This example shows how to list all the active domains:
import digitalocean
TOKEN="secretspecialuniquesnowflake"
manager = digitalocean.Manager(token=TOKEN)
my_domains = manager.get_all_domains()
print(my_domains)This example shows how to list all records of a domain:
import digitalocean
TOKEN="secretspecialuniquesnowflake"
domain = digitalocean.Domain(token=TOKEN, name="example.com")
records = domain.get_records()
for r in records:
print(r.name, r.domain, r.type, r.data)This example shows how to create new domain record (sub.example.com):
import digitalocean
TOKEN="secretspecialuniquesnowflake"
domain = digitalocean.Domain(token=TOKEN, name="example.com")
new_record = domain.create_new_domain_record(
type='A',
name='sub',
data='93.184.216.34'
)
print(new_record)This example shows how to create new domain record (sub.example.com):
import digitalocean
TOKEN="secretspecialuniquesnowflake"
domain = digitalocean.Domain(token=TOKEN, name="example.com")
records = domain.get_records()
id = None
for r in records:
if r.name == 'usb':
r.data = '1.1.1.1'
r.save()Each request will also include the rate limit information:
import digitalocean
account = digitalocean.Account(token="secretspecialuniquesnowflake").load()
# or
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
account = manager.get_account()Output:
droplet_limit: 25
email: 'name@domain.me'
email_verified: True
end_point: 'https://api.digitalocean.com/v2/'
floating_ip_limit: 3
ratelimit_limit: '5000'
ratelimit_remaining: '4995'
ratelimit_reset: '1505378973'
status: 'active'
status_message: ''
token:'my_secret_token'
uuid: 'my_id'
When using the Manager().get_all.. functions, the rate limit will be stored on the manager object:
import digitalocean
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
domains = manager.get_all_domains()
print(manager.ratelimit_limit)You can take advandtage of the requests library and configure the HTTP client under python-digitalocean.
This example shows how to configure your client to retry 3 times in case of ConnectionError:
import digitalocean
import requests
from requests.adapters import HTTPAdapter
from requests.packages.urllib3.util.retry import Retry
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
retry = Retry(connect=3)
adapter = HTTPAdapter(max_retries=retry)
manager._session.mount('https://', adapter)See Retry object reference to get more details about all retries options.
This example shows how to launch custom actions if a HTTP 500 occurs:
import digitalocean
def handle_response(response, *args, **kwargs):
if response.status_code == 500:
# Make a lot things from the raw response
pass
return response
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
manager._session.hooks['response'].append(handle_response)See event hooks documentation to get more details about this feature.
To test this python-digitalocean you can use docker to have a clean environment automatically. First you have to build the container by running in your shell on the repository directory:
docker build -t "pdo-tests" .
Then you can run all the tests (for both python 2 and python 3)
docker run pdo-tests
Note: This will use Ubuntu 14.04 as base and use your repository to run tests. So every time you edit some files, please run these commands to perform tests on your changes.
Use pytest to perform testing. It is recommended to use a dedicated virtualenv to perform tests, using these commands:
$ virtualenv /tmp/digitalocean_env
$ source /tmp/digitalocean_env/bin/activate
$ pip install -r requirements.txt
To run all the tests manually use py.test command:
$ python -m pytest
- GitHub: https://github.com/koalalorenzo/python-digitalocean
- PyPI page: https://pypi.python.org/pypi/python-digitalocean/
- Author Website: http://who.is.lorenzo.setale.me/?
- Author Blog: http://blog.setale.me/