Getting started with pycpg

Licensing
Installation
Authentication
Troubleshooting and Support

Licensing

This project uses the MIT License.

Installation

You can install pycpg from PyPI, from source, or from distribution.

From PyPI

The easiest and most common way is to use pip:

pip install pycpg

To install a previous version of pycpg via pip, add the version number. For example, to install version 1.0.1, you would enter:

pip install pycpg==1.0.1

Visit the project history on PyPI to see all published versions.

From source

Alternatively, you can install pycpg directly from source code:

git clone https://github.com/CrashPlan-Labs/pycpg.git

When it finishes downloading, from the root project directory, follow the instruction to package and install the project

To create a .tar ball for installing elsewhere, run this command from the project’s root directory:

python -m pip install build
python -m build --sdist

After it finishes building, the .tar ball will be located in the newly created dist directory. To install it, enter:

pip install pycpg-[VERSION].tar.gz

Authentication

Important

pycpg currently only supports token-based authentication.

To initialize the pycpg.sdk.SDKClient, you must provide your credentials. If you are writing a script, we recommend using a secure password storage library, such as keyring, for retrieving passwords and secrets. However, subsequent requests use JWT authentication.

Basic Authentication

Pycpg supports basic auth with your CrashPlan username and password.

If your account uses two-factor authentication, include the time-based one-time password (TOTP) when you initialize the pycpg.sdk.SDKClient. You can also provide a callable object that returns a TOTP. If you pass a callable, it will be called whenever a new TOTP is required to renew the authentication token.

import pycpg.sdk

sdk = pycpg.sdk.from_local_account("https://console.us1.crashplan.com", "username@crashplan.com", "password")

CrashPlan API Clients

Pycpg also supports api clients. You can use the client ID and secret generated through the CrashPlan console to initiate the SDKClient.

import pycpg.sdk

sdk = pycpg.sdk.from_api_client("https://console.us1.crashplan.com", "key-123-42", "my%secret!")

Troubleshooting and support

Debug mode

Debug mode may be useful if you are trying to determine if you are experiencing permissions issues. When debug mode is on, pycpg logs HTTP request data to the console’s stderr. Use the following as a guide for how to turn on debug mode in pycpg:

import pycpg.sdk
import pycpg.settings
import logging

pycpg.settings.debug.level = logging.DEBUG

To provide your own logger, just replace pycpg.settings.debug.logger:

custom_logger = logging.getLogger("my_app")
handler = logging.FileHandler("my_app.log")
custom_logger.addHandler(handler)

pycpg.settings.debug.logger = custom_logger

File an issue on GitHub

If you are experiencing an issue with pycpg, you can create a New issue at the project repository. See the Github guide on creating an issue for more information.

Contact CrashPlan Support

If you don’t have a GitHub account and are experiencing issues, contact CrashPlan support.

What’s next?

Learn the basics by following the pycpg Basics guide.