Skip to main content

Python client API to access SecureDrop Journalist REST API

Project description

Python SDK for SecureDrop

This SDK provides a convenient Python interface to the SecureDrop Journalist Interface API. The development of the SDK was primarily motivated by the creation of the SecureDrop Workstation based on Qubes OS.

The SDK is currently used by the SecureDrop Client that is a component of the SecureDrop Workstation. When used in Qubes OS, the SDK uses the securedrop-proxy service, as the VM which runs the client does not have network access by design.

IMPORTANT: This project is still under active development. We do not recommend using it in any production context.

Development

This project uses pipenv to manage all dependencies. This is a Python 3 project.

We are using mypy for type annotation checks.

We cover all the API calls supported by the SecureDrop Journalist Interface API.

Additional tests will be added in future.

Testing

To test the code, you will need to run the SecureDrop make dev command on the same system. The test suite for this project will test against that development container.

License: GPLv3+

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

securedrop-sdk-0.0.5.tar.gz (18.7 kB view details)

Uploaded Source

File details

Details for the file securedrop-sdk-0.0.5.tar.gz.

File metadata

  • Download URL: securedrop-sdk-0.0.5.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.5.3

File hashes

Hashes for securedrop-sdk-0.0.5.tar.gz
Algorithm Hash digest
SHA256 55a0a210f5cb7e499f364a8f737400ae41c0ca336d4b72022fe05646005d80b4
MD5 f1b66505efae60bd9084150d767d23e3
BLAKE2b-256 78bb5092574786a854005c95989fd1559ea069f0998c4451ea7b89ca3394f0cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page