Skip to content

Tooling for developing against the SecureDrop API

License

Notifications You must be signed in to change notification settings

rmol/securedrop-sdk

 
 

Repository files navigation

Python SDK for SecureDrop

CircleCI

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. When using pipenv locally, ensure you used the --keep-outdated flag to prevent dependencies from being unnecessarily upgraded during normal development.

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+

About

Tooling for developing against the SecureDrop API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 97.3%
  • Makefile 2.7%