python-digitalocean

python-digitalocean

This library provides easy access to Digital Ocean APIs to deploy droplets, images and more.

|image0|

| |image1| | |image2| | |image3|

How to install

You can install python-digitalocean using pip

::

pip install -U python-digitalocean

or via sources:

::

python setup.py install

Features

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

Examples

Listing the droplets

This example shows how to list all the active droplets:

.. code:: python

    import digitalocean
    manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
    print(manager.get_all_droplets())

Shutdown all droplets

This example shows how to shutdown all the active droplets:

.. code:: python

import digitalocean
manager = digitalocean.Manager(token="secretspecialuniquesnowflake")
my_droplets = manager.get_all_droplets()
for droplet in my_droplets:
    droplet.shutdown()

Creating a Droplet and checking its status

This example shows how to create a droplet and how to check its status

.. code:: python

    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()

Checking the status of the droplet
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    actions = droplet.get_actions()
    for action in actions:
        action.load()
        # Once it shows complete, droplet is up and running
        print action.status

Add SSHKey into DigitalOcean Account
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    from 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()

Creating a new droplet with all your SSH keys

.. code:: python

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()

Testing

Test using Docker

To test this python-digitalocean you can use
`docker <https://www.docker.com>`__ 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.

Testing using pytest manually

Use pytest <http://pytest.org/>__ 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

Links

• GitHub: https://github.com/koalalorenzo/python-digitalocean
• PyPI page: https://pypi.python.org/pypi/python-digitalocean/
• Author Website: http://who.is.lorenzo.setale.me/? <http://setale.me/>__
• Author Blog: http://blog.setale.me/

.. |image0| image:: https://travis-ci.org/koalalorenzo/python-digitalocean.svg :target: https://travis-ci.org/koalalorenzo/python-digitalocean .. |image1| image:: https://img.shields.io/github/forks/badges/shields.svg?style=social&label=Fork :target: https://travis-ci.org/koalalorenzo/python-digitalocean .. |image2| image:: https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star :target: https://travis-ci.org/koalalorenzo/python-digitalocean .. |image3| image:: https://img.shields.io/github/watchers/badges/shields.svg?style=social&label=Watch :target: https://travis-ci.org/koalalorenzo/python-digitalocean