pontoon

A Python CLI (and library) for Digital Ocean.

Introduction

Pontoon makes interacting with Digital Ocean on the command line smooth sailing.

It is designed for human consumption, and aims to have good defaults.

Caveats

Pontoon has one rule it imposes on top of Digital Ocean:

Names are unique.

Unique names make for a much easier command line experience. For Droplets, names are hostnames, and hostnames should be unique anyway; it’s just a good idea.

They don’t have to be unique forever though; once a Droplet is destroyed, it’s fine to use the name again.

Anything “recommended” (like secure-erasing the drive on termination) is optional, but enabled by default.

User Guide

Installation

Via pip:

$ pip install pontoon

Pontoon works with Pythons 2.6 through 3.5, and should work on any Linux/BSD with Python support.

It’s also possible to use pontoon on Windows, though portions of the configuration command (which make use of Linux CLI tools like OpenSSH) do not work.

CLI Usage

Configure

Set up your credentials and preferences:

$ pontoon configure

You’ll be prompted for your Digital Ocean API credentials (available here), and whether you want to use existing SSH credentials or for them to be generated (using OpenSSH).

The rest are preferences, and can be set at any time by running configure again, editing the ~/.pontoon config file (YAML format), or by specifying them with options on the command line.

Configuration File

Here’s an example of the options set in the configuration file:

api_token: foo-bar-baz
auth_key_name: Macbook.local
image: ubuntu-15-10-x32
region: lon1
size: 512mb
ssh_private_key: ~/.ssh/id_rsa
ssh_public_key: ~/.ssh/id_rsa.pub
username: root

Managing Droplets is probably what you’ll spend most of your time doing with pontoon.

You can get a full list of subcommands and options by running:

$ pontoon droplet --help

Basic Usage

Creating and destroying Droplets is very straight forward:

$ pontoon droplet create my-droplet
Creating Droplet my-droplet (512mb using ubuntu-15-10-x32 in lon1)...
...............active
$ pontoon droplet destroy my-droplet
Destroying ud1 and scrubbing data...

To SSH into your Droplet:

$ pontoon droplet ssh my-droplet
Welcome to Ubuntu 15.10 (GNU/Linux 4.2.0-27-generic i686)

* Documentation:  https://help.ubuntu.com/
Last login: Sun Mar  6 10:41:17 2016 from 192.168.1.200

To get a list of your Droplets:

$ pontoon droplet list
my-droplet:    (512mb, ubuntu-15-10-x32, lon1, 104.236.32.182, active)

See the Command Reference for more.

Command Reference

A complete list of commands and their options.

Available on the command line by appending --help to the command.

Configure

The configure command interactively configures pontoon.

You’re prompted for details and a configuration file is written to ~/.pontoon.

Alternatively, you can manually place a config file at this location with this syntax:

api_token: foo-bar-baz
auth_key_name: Macbook.local
image: ubuntu-15-10-x32
region: lon1
size: 512mb
ssh_private_key: ~/.ssh/id_rsa
ssh_public_key: ~/.ssh/id_rsa.pub
username: root

pontoon configure

Launch interactive configuration of pontoon.

Droplets

pontoon droplet list [options]

--detail

Show full Droplet info.

$ pontoon droplet list --detail
example.com
id: 3164444
size: 512mb
image: ubuntu-14-04-x64
region: nyc3
ip_address: 104.236.32.182
status: active
kernel:
   id: 2233
   name: Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic
   version: 3.13.0-37-generic
...

pontoon droplet create <name> [options]

--size size

Droplet RAM allocation. e.g., 512mb

--image image

Droplet image.

--region region

Droplet region.

--keys keys...

List of registered keys to add to Droplet(s)

--user-data userdata

String of user data to pass to Droplet. Include a file like: --user-data="$(cat file.yml)"

--private-networking

Assign private address to Droplet (where available)

--disable-virtio

Disable VirtIO. (not recommended)

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet ssh <name> [command] [options]

--user user

Override configured username for SSH login.

--key path

Override configured private key for SSH login.

pontoon droplet rename <from> <to> [options]

Rename a Droplet. Takes the current name as the first parameter, and the new name as the second.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet resize <name> <size> [options]

Resize a Droplet. Takes Droplet name as first paramter, size as second.

--yes

Don’t prompt for confirmation.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet snapshot <droplet> <snapshot> [options]

Snapshot a Droplet. Takes Droplet name as first paramter, snapshot name as second.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet show <name> [options]

Show detailed information about a particular Droplet.

--field field

Extract and return a single field. Access nested items with dot syntax, e.g.: networks.v4.0.gateway

pontoon droplet status <name>

Return Droplet status.

pontoon droplet destroy <name>

Destroy a Droplet.

pontoon droplet start <name>

Start a Droplet.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet shutdown <name>

Shut down a Droplet.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet reboot <name>

Reboot a Droplet (sending signal to OS).

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet restore <name> <snapshot>

Restore a Droplet from a snapshot.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet rebuild <name> <image>

Rebuild a Droplet from a given image.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet powercycle <name>

Powercycle (hard restart) a Droplet.

--yes

Don’t prompt for confirmation.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet poweroff <name>

Power off (without signalling the OS) a Droplet.

--yes

Don’t prompt for confirmation.

--no-wait

Don’t wait for action to complete, return immediately.

pontoon droplet passwordreset <name>

Reset the root password on a Droplet.

--yes

Don’t prompt for confirmation.

pontoon droplet backups <name>

Manage backups on a Droplet.

--enable

Enable backups.

--disable

Depracated by Digital Ocean for their v2 API release, later added back but still deprecated here for the moment.

Events

These is an interface to Digital Ocean events.

Events are usually only an implementation detail, and an interface is provided here only for completeness.

pontoon event show <id>

Retrieve details for a particular event id.

Images

Public base images made available by Digital Ocean.

pontoon image list [options]

Retrieve a list of public images.

--with-ids

Include image IDs in tabular output.

pontoon image oses

Retrieve a list of Operating Systems for which there are base images.

pontoon image show <name>

Show details for a particular image, including regions where it is available.

Regions

Regions available to launch Droplets.

pontoon region list

List regions in which Droplets can be launched.

Sizes

Droplet sizes available.

pontoon size list

List sizes of Droplets which can be launched.

Snapshots

Commands for interacting with snapshots.

pontoon snapshot list [options]

List available snapshots.

--with-ids

Include image IDs in tabular output.

pontoon snapshot show <name>

Show snapshot details.

pontoon snapshot destroy <name>

Destroy a snapshot.

pontoon snapshot transfer <name> <region>

Move a snapshot from one region to another. A list of regions can be retrieved with pontoon region list

SSH Keys

Manage SSH keys in your account.

pontoon sshkey list

List of SSH keys in account.

pontoon sshkey add <name> <public-key-path>

Register a public SSH key from the specified path to your account.

pontoon sshkey show <name>

Retrieve a public key by name.

pontoon sshkey replace <name> <public-key-path>

Replace an existing key name with a new public key.

pontoon sshkey destroy <name>

Remove a given key from Digital Ocean. Note: this doesn’t remove the key from any existing Droplets, just removes it from the keys available to boot Droplets with.

Developer / Contributor Guide

Developer Interface

This part of the documentation covers all the interfaces of Pontoon.

Library Module

pontoon.lib is the main entry point for using the library as a developer.

digitalocean API to manage droplets

Manager Class

class pontoon.lib.Manager(*args, **kwargs)

_Manager__deal_with_pagination(url, data, params)

Perform multiple calls in order to have a full list of elements when the API are “paginated”. (content list is divided in more than one page)

get_account()

Returns an Account object.

get_action(action_id)

Return an Action object by a specific ID.

get_all_actions()

This functions returns a list of Action objects.

get_all_domains()

This function returns a list of Domain object.

get_all_droplets()

This function returns a list of Droplet object.

get_all_floating_ips()

This function returns a list of FloatingIP objects.

get_all_images()

This function returns a list of Image objects containing all available DigitalOcean images, both public and private.

get_all_regions()

This function returns a list of Region object.

get_all_sizes()

This function returns a list of Size object.

get_all_sshkeys()

This function returns a list of SSHKey object.

get_app_images()

This function returns a list of Image objectobjects representing public DigitalOcean ‘One-Click’ application images.

get_data(*args, **kwargs)

Customized version of get_data to perform __check_actions_in_data.

The default amount of elements per page defined is 200 as explained here: https://github.com/koalalorenzo/python-digitalocean/pull/78

get_distro_images()

This function returns a list of Image objects representing public base distribution images.

get_domain(domain_name)

Return a Domain by its domain_name

get_droplet(droplet_id)

Return a Droplet by its ID.

get_floating_ip(ip)

Returns a of FloatingIP object by its IP address.

get_global_images()

This function returns a list of Image objects representing public DigitalOcean images (e.g. base distribution images and ‘One-Click’ applications).

get_image(image_id)

Return a Image by its ID.

get_images(private=False, type=None)

This function returns a list of Image object.

get_my_images()

This function returns a list of Image objects representing private DigitalOcean images (e.g. snapshots and backups).

get_ssh_key(ssh_key_id)

Return a SSHKey object by its ID.

Droplet Class

class pontoon.lib.Droplet(*args, **kwargs)

“Droplet management

Attributes accepted at creation time:

name: str - name size_slug: str - droplet size image: str - image name to use to create droplet region: str - region ssh_keys: [str] - list of ssh keys backups: bool - True if backups enabled ipv6: bool - True if ipv6 enabled private_networking: bool - True if private networking enabled user_data: str - arbitrary data to pass to droplet

Attributes returned by API:

id: int - droplet id memory: str - memory size vcpus: int - number of vcpus disk: int - disk size in GB status: str - status locked: bool - True if locked created_at: str - creation date in format u‘2014-11-06T10:42:09Z’ status: str - status, e.g. ‘new’, ‘active’, etc networks: dict - details of connected networks kernel: dict - details of kernel backup_ids: [int] - list of ids of backups of this droplet snapshot_ids: [int] - list of ids of snapshots of this droplet action_ids: [int] - list of ids of actions features: [str] - list of enabled features. e.g.

[u’private_networking’, u’virtio’]

min_size: str - minumum size of droplet that can bew created from a

snapshot of this droplet

image: dict - details of image used to create this droplet ip_address: str - public ip addresses private_ip_address: str - private ip address ip_v6_address: [str] - list of ipv6 addresses assigned end_point: str - url of api endpoint used

_Droplet__get_ssh_keys_id_or_fingerprint()

Check and return a list of SSH key IDs or fingerprints according to DigitalOcean’s API. This method is used to check and create a droplet with the correct SSH keys.

_perform_action(params, return_dict=True)

Perform a droplet action.

Args:

params - dict : parameters of the action

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

change_kernel(kernel, return_dict=True)

Change the kernel to a new one

Args:

kernel : instance of digitalocean.Kernel.Kernel

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

create(*args, **kwargs)

Create the droplet with object properties.

Note: Every argument and parameter given to this method will be assigned to the object.

destroy()

Destroy the droplet

Returns dict

disable_backups(return_dict=True)

Disable automatic backups

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

enable_backups()

Enable automatic backups (Not yet implemented in APIv2)

enable_ipv6(return_dict=True)

Enable IPv6 on an existing Droplet where available.

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

enable_private_networking(return_dict=True)

Enable private networking on an existing Droplet where available.

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

get_action(action_id)

Returns a specific Action by its ID.

Args:

action_id: int - id of action

get_actions()

Returns a list of Action objects This actions can be used to check the droplet’s status

get_data(*args, **kwargs)

Customized version of get_data to perform __check_actions_in_data

get_events()

A helper function for backwards compatability. Calls get_actions()

get_kernel_available()

Get a list of kernels available

classmethod get_object(api_token, droplet_id, mocked)

Class method that will return a Droplet object by ID.

Args:

api_token: str - token droplet_id: int - droplet id mocked: bool - mocked

get_snapshots()

This method will return the snapshots/images connected to that specific droplet.

load()

Fetch data about droplet - use this instead of get_data()

power_cycle(return_dict=True)

restart the droplet

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

power_off(return_dict=True)

restart the droplet

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

power_on(return_dict=True)

Boot up the droplet

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

reboot(return_dict=True)

restart the droplet

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

rebuild(image_id=None, return_dict=True)

Restore the droplet to an image ( snapshot or backup )

Args:

image_id : int - id of image

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

rename(name, return_dict=True)

Rename the droplet

Args:

name : str - new name

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

reset_root_password(return_dict=True)

reset the root password

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

resize(new_size_slug, return_dict=True, disk=True)

Resize the droplet to a new size slug. https://developers.digitalocean.com/documentation/v2/#resize-a-droplet

Args:

new_size_slug: str - name of new size

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

disk - bool : If a permanent resize, with disk changes included.

Returns dict or Action

restore(image_id, return_dict=True)

Restore the droplet to an image ( snapshot or backup )

Args:

image_id : int - id of image

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

shutdown(return_dict=True)

shutdown the droplet

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

Returns dict or Action

take_snapshot(snapshot_name, return_dict=True, power_off=False)

Take a snapshot!

Args:

snapshot_name: str - name of snapshot

Optional Args:

return_dict - bool : Return a dict when True (default),

otherwise return an Action.

power_off - bool : Before taking the snapshot the droplet will be

turned off with another API call. It will wait until the droplet will be powered off.

Returns dict or Action

Account Class

class pontoon.lib.Account(*args, **kwargs)

classmethod get_object(api_token, mocked)

Class method that will return an Account object.

Action Class

class pontoon.lib.Action(*args, **kwargs)

classmethod get_object(api_token, action_id, mocked)

Class method that will return a Action object by ID.

wait(update_every_seconds=1)

Wait until the action is marked as completed or with an error. It will return True in case of success, otherwise False.

Optional Args:

update_every_seconds - int : number of seconds to wait before

checking if the action is completed.

Domain Class

class pontoon.lib.Domain(*args, **kwargs)

create()

Create new domain

create_new_domain_record(*args, **kwargs)

Create new domain record. https://developers.digitalocean.com/#create-a-new-domain-record

Args:

@type The record type (A, MX, CNAME, etc). @name The host name, alias, or service being defined by the record @data Variable data depending on record type.

Optional Args:

@priority The priority of the host @port The port that the service is accessible on @weight The weight of records with the same priority

destroy()

Destroy the domain by name

classmethod get_object(api_token, domain_name, mocked)

Class method that will return a Domain object by ID.

get_records(params=None)

Returns a list of Record objects

load()

FloatingIP Class

class pontoon.lib.FloatingIP(*args, **kwargs)

assign(droplet_id)

Assign a FloatingIP to a Droplet.

Args:

droplet_id: int - droplet id

create(*args, **kwargs)

Creates a FloatingIP and assigns it to a Droplet.

Note: Every argument and parameter given to this method will be assigned to the object.

Args:

droplet_id: int - droplet id

destroy()

Destroy the FloatingIP

classmethod get_object(api_token, ip, mocked)

Class method that will return a FloatingIP object by its IP.

Args:

api_token: str - token ip: str - floating ip address

load()

Load the FloatingIP object from DigitalOcean.

Requires self.ip to be set.

reserve(*args, **kwargs)

Creates a FloatingIP in a region without assigning it to a specific Droplet.

Note: Every argument and parameter given to this method will be assigned to the object.

Args:

region_slug: str - region’s slug (e.g. ‘nyc3’)

unassign()

Unassign a FloatingIP.

Image Class

class pontoon.lib.Image(*args, **kwargs)

destroy()

Destroy the image

classmethod get_object(api_token, image_id, mocked)

Class method that will return an Image object by ID.

rename(new_name)

Rename an image

transfer(new_region_slug)

Transfer the image

Kernel Class

class pontoon.lib.Kernel(*args, **kwargs)

Record Class

class pontoon.lib.Record(domain_name=None, *args, **kwargs)

create()

Create a record for a domain

destroy()

Destroy the record

classmethod get_object(api_token, domain, record_id)

Class method that will return a Record object by ID and the domain.

save()

Save existing record

Region Class

class pontoon.lib.Region(*args, **kwargs)

SSHKey Class

class pontoon.lib.SSHKey(*args, **kwargs)

create()

Create the SSH Key

destroy()

Destroy the SSH Key

edit()

Edit the SSH Key

classmethod get_object(api_token, ssh_key_id, mocked)

Class method that will return a SSHKey object by ID.

load()

Load the SSHKey object from DigitalOcean.

Requires either self.id or self.fingerprint to be set.

load_by_pub_key(public_key)

This method will laod a SSHKey object from DigitalOcean from a public_key. This method will avoid problem like uploading the same public_key twice.

Size Class

class pontoon.lib.Size(*args, **kwargs)

UI module

This module handles all output for the CLI, as well as some filesystem interactions. This is the only location outside of tests where the print statement is invoked directly.

pontoon.ui.ask(question)

Present a question with freeform input on an interactive prompt

pontoon.ui.ask_yesno(question)

Present a string as a yes/no question on an interactive prompt

pontoon.ui.box(text, decor='*', decor_x=None, decor_y=None, boxwidth=60, borderwidth=2)

Create a formatted textbox for highlighting important information

pontoon.ui.filename_from_path(path)

Get a filename from a given path

pontoon.ui.format_droplet_info(machine)

Present Droplet information in a more human parseable format

pontoon.ui.format_event(action)

Present event information in a more human parseable format

pontoon.ui.format_item(item)

Present any item in more human parseable format

pontoon.ui.full_path(path)

Expand a ~/ prefixed path to a full path

pontoon.ui.heading(text, boxwidth=60)

Create a ‘heading’ styled textbox

pontoon.ui.line(length=60, decor='-')

Write a line

pontoon.ui.machine()

pontoon.ui.mask(text, masker='*')

Hide part of a string,

If the input is small, hide the entire string. Otherwise, show only the last few characters.

pontoon.ui.message(text)

Wrapper for the print function

pontoon.ui.notify(text, boxwidth=60)

Create a ‘notification’ styled textbox

pontoon.ui.ordered_dump(data, stream=None, Dumper=<class 'yaml.dumper.Dumper'>, **kwds)

pontoon.ui.ticker()

A loading/waiting indicator.

Sends a ‘.’ to the screen, resets, and sleeps.

pontoon.ui.valid_path(path)

Check whether a given string resolves to a path on the filesystem

pontoon.ui.warning(text, boxwidth=60)

Create a ‘warning’ styled textbox

pontoon.ui.yaml_message(data)

Formats output as ordered YAML

Mocking Module

class pontoon.mocking.Data

pontoon.mocking._raise(ex=None)

Wrapper for exceptions so they can be thrown from inside lambdas

pontoon.mocking.capture_stdout(*args, **kwds)

Captures STDOUT and turns it into an object

pontoon.mocking.event_response()

pontoon.mocking.get_builtins()

Python 2.x and 3.x have different names for accessing builtins

pontoon.mocking.timestamp(hours=0)

Mocked Digital Ocean timestamp

Log Module

pontoon.log.debug(obj)

Exceptions

exception pontoon.exceptions.ConfigureException

An error occurred while processing the configuration file

exception pontoon.exceptions.PontoonException

An ambiguous error occurred while handling the command

Configure Module

The configure module is a collection of methods for handling interaction with some external tools, config files, and for interactive configuration.

pontoon.configure.combined(*args, **kwargs)

Merge configuration defaults with values from config file.

pontoon.configure.create_config(*args, **kwargs)

Create a YAML config file from a dictionary

pontoon.configure.images(credentials)

Retrieve image options

pontoon.configure.logger()

Prepare interface to logging.

pontoon.configure.read_config(*args, **kwargs)

Read a YAML formatted config into a dictionary

pontoon.configure.read_key(*args, **kwargs)

Read a public SSH key from the filesystem

pontoon.configure.regenerate_public_key(*args, **kwargs)

Generate an SSH public key from an existing private key.

pontoon.configure.regions(credentials)

Retrieve region options

pontoon.configure.register_key(*args, **kwargs)

Register an SSH key with Digital Ocean

pontoon.configure.rsa_keygen(*args, **kwargs)

Create a new SSH key

pontoon.configure.sizes(credentials)

Retrieve size options

pontoon.configure.ssh_tools(*args, **kwargs)

Checks for existance of SSH tools required for creating keys.

Command Class

The Command class encapsulates plumbing common to all CLI commands.

class pontoon.command.Command

Base class for CLI commands.

Parses docstrings and initalizes client.

run(override=None)

Run the command specified by the docstring.

Parameters:override – Run a command other than the one specified.

Contributing

Pull requests for bugs are always welcome! New functionality should generally be preceded by a discussion, though if you’ve written something that you needed and want to contribute back, a pull request is a fine way to start that discussion :)

All of the code in pontoon is PEP-8 audited (using pytest-pep8), and there’s a full suite of tests written for py.test (library code) and Bats (interface). Contributions should, therefore, include tests and pass a PEP-8 audit.

Running the tests

Running the tests locally requires the contents of requirements.txt as well as bats.

$ pip install -r requirements.txt

On OSX, bats can be installed with homebrew:

$ brew install bats

On Debian/Ubuntu, I’ve set up a PPA for easy installation of bats:

$ add-apt-repository ppa:duggan/bats
$ apt-get update
$ apt-get install bats

Tests can then be run from the root directory:

$ py.test --pep8 --cov pontoon
$ bats test/bats

Debugging

Set the DEBUG environment variable (to anything) to enable debug output for pontoon.

This will give a step through of most methods being executed during a command, like so:

$ DEBUG=1 pontoon droplet destroy foobar
2013-11-09 18:37:06,187 [pontoon.configure:DEBUG] combined: (){}
2013-11-09 18:37:06,187 [pontoon.configure:DEBUG] read_config: (){}
Destroying foobar and scrubbing data...
2013-11-09 18:37:06,204 [pontoon.droplet:DEBUG] destroy: (<pontoon.droplet.Droplet instance at 0x10ce1fd40>, 'foobar', False){}
2013-11-09 18:37:06,204 [pontoon.droplet:DEBUG] id_from_name: (<pontoon.droplet.Droplet instance at 0x10ce1fd40>, 'foobar'){}
2013-11-09 18:37:06,204 [pontoon.droplet:DEBUG] list: (<pontoon.droplet.Droplet instance at 0x10ce1fd40>,){}
2013-11-09 18:37:06,205 [pontoon.pontoon:DEBUG] render: (<pontoon.pontoon.Pontoon instance at 0x10ce1fcf8>, 'droplets', '/droplets'){}
2013-11-09 18:37:06,205 [pontoon.pontoon:DEBUG] request: (<pontoon.pontoon.Pontoon instance at 0x10ce1fcf8>, '/droplets'){'params': {}, 'method': 'GET'}
2013-11-09 18:37:07,498 [pontoon.pontoon:DEBUG] render: (<pontoon.pontoon.Pontoon instance at 0x10ce1fcf8>, 'event_id', '/droplets/998/destroy'){'params': {'scrub_data': 1}}
2013-11-09 18:37:07,498 [pontoon.pontoon:DEBUG] request: (<pontoon.pontoon.Pontoon instance at 0x10ce1fcf8>, '/droplets/998/destroy'){'params': {'scrub_data': 1}, 'method': 'GET'}

A timestamp, followed by the module, debug level, the method called and the arguments to that method (positional as brackets, keywords as curlies).

This functionality is implemented by the @debug decorator, the code for which can be seen at pontoon/log.py.

Mocking

Set the MOCK environment variable (to anything) to return mock request data instead of querying Digital Ocean.

This is implemented solely for end-to-end testing of the CLI, but you may find it useful in some other scenarios.

Addendum

Windows support

Pontoon’s lack of Windows support is a bug, not a feature. If you need pontoon on Windows, the best way to help get it there is with a pull request.

Indices and tables

• Index
• Module Index
• Search Page