py42, the official Code42 Python SDK
py42 is a Python wrapper around the Code42 REST APIs that also provides several other useful utility methods.
It is designed to be used for developing your own tools for working with Code42 data while avoiding the overhead
of session / authentication management.
Requirements
- Python 2.7.x or 3.5.0+
- Code42 Server 6.8.x+ or cloud environment (e.g. console.us.code42.com or crashplan.com)
Installation
Run the setup.py script to install the py42 package and its dependencies on your system.
You will likely need administrative privileges for this.
$ python setup.py install
Hello, py42
Here's a simple example to verify the installation and your server/account.
Launch the Python interpreter
$ python
Import a couple essentials
>>> import py42.sdk
>>> import py42.util as util
Initialize the client.
>>> sdk = py42.sdk.from_local_account("https://console.us.code42.com", "john.doe", "password")
or alternatively
>>> sdk = py42.sdk.from_jwt_provider("https://console.us.code42.com", jwt_provider_function)
Get and print your user information.
>>> response = sdk.users.get_current()
>>> util.print_response(response)
You should see something like the following:
{
"username": "john.doe",
"orgName": "ACME Organization",
"userId": 123456,
"emailPromo": true,
"licenses": [],
"modificationDate": "2018-08-29T15:32:56.995-05:00",
"blocked": false,
"usernameIsAnEmail": true,
"userUid": "1234567890abcdef",
"userExtRef": null,
"email": "john.doe@acme.com",
"status": "Active",
"localAuthenticationOnly": false,
"orgUid": "123456789123456789",
"passwordReset": true,
"active": true,
"creationDate": "2012-01-16T11:25:43.545-06:00",
"orgType": "BUSINESS",
"firstName": "John",
"lastName": "Doe",
"notes": null,
"orgId": 123456,
"quotaInBytes": -1,
"invited": false
}
Configuration
There are a few default settings that affect the behavior of the client.
| Name | Description | Default |
|---|---|---|
| verify_ssl_certs | Controls whether the SDK verifies the server's certificate. Possible values: True, False, or a path to a CA bundle to use. |
True |
| proxies | Dictionary mapping protocol or protocol and hostname to the URL of the proxy. See the Requests library's documentation on proxies for more info. |
None |
| debug.level | Controls log level | logging.NOTSET |
| debug.logger | Controls logger used | logging.Logger with StreamHandler sending to sys.stderr |
| items_per_page | Controls how many items are retrieved per request for methods that loops over several "pages" of items in order to collect them all. | 500 |
To override these settings, import py42.settings and override values as necessary before creating the client.
For example, to disable certificate validation in a dev environment:
import py42.sdk
import py42.settings as settings
import logging
settings.verify_ssl_certs = False
# customize logging
custom_logger = logging.getLogger("my_app")
handler = logging.FileHandler("my_app.log")
custom_logger.addHandler(handler)
settings.debug.logger = custom_logger
settings.debug.level = logging.DEBUG
sdk = py42.sdk.from_local_account("https://console.us.code42.com", "my_username", "my_password")
Usage
The SDK object opens availability to APIs across the Code42 environment, including storage nodes.
import py42.sdk
sdk = py42.sdk.from_local_account("https://console.us.code42.com", "my_username", "my_password")
# clients are organized by feature groups and accessible under the sdk object
# get information about the current user.
current_user = sdk.users.get_current()
# page through all devices available to this user.
for device_page in sdk.devices.get_all():
for device in device_page["computers"]:
print(device)
# page through all orgs available to this user.
for org_page in sdk.orgs.get_all():
for org in org_page["orgs"]:
print(org)
# save a copy of a file from an archive this user has access to into the current working directory.
stream_response = sdk.archive.stream_from_backup("/full/path/to/file.txt", "1234567890")
with open("/path/to/my/file", 'wb') as f:
for chunk in stream_response.iter_content(chunk_size=128):
if chunk:
f.write(chunk)
# search file events
from py42.sdk.queries.fileevents.file_event_query import FileEventQuery
from py42.sdk.queries.fileevents.filters import *
query = FileEventQuery.all(MD5.eq("e804d1eb229298b04522c5504b8131f0"))
file_events = sdk.securitydata.search_file_events(query)
Additional Resources
For complete documentation on the Code42 web API that backs this SDK, here are some helpful resources:
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file py42-1.16.1.tar.gz.
File metadata
- Download URL: py42-1.16.1.tar.gz
- Upload date:
- Size: 88.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30b4b2222c938204d7aea143eeeb7731784cd83ea643a2aa05fd205842c92e0f
|
|
| MD5 |
5f034dbf1ed9a6a73fc990926d863de7
|
|
| BLAKE2b-256 |
4919041613460d4d61c2df181b19ddf4741ac929b09a73d23f28b2c6c0f6fc54
|
File details
Details for the file py42-1.16.1-py2.py3-none-any.whl.
File metadata
- Download URL: py42-1.16.1-py2.py3-none-any.whl
- Upload date:
- Size: 99.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7274738c20a5898b742d8b7407aa6a88fa03dc31abaade38df5cf668cb15b9e8
|
|
| MD5 |
3f967370dde9b42ade8e241c04b8f99d
|
|
| BLAKE2b-256 |
eddb6c3b99b415b15d85ae5786f9e5d0bf0d54bb1d22015bf4c7784b506e91e0
|
