Python client API to access SecureDrop Journalist REST API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for creviera from gravatar.com creviera Avatar for freedomofpress from gravatar.com freedomofpress Avatar for kstop from gravatar.com kstop Avatar for kushaldas from gravatar.com kushaldas

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (GPLv3+)
  • Author: Kushal Das
  • Requires: Python >=3.5
Classifiers

Project description

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.

Release

To make a release, you should:

  1. Update the version in setup.py.
  2. Update the changelog.
  3. Commit the changes, and git tag.
  4. Create a PR, push the new tag, and get the PR reviewed and merged into master.
  5. Push the new release to the PSF's PyPI following this documentation.

License: GPLv3+

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for creviera from gravatar.com creviera Avatar for freedomofpress from gravatar.com freedomofpress Avatar for kstop from gravatar.com kstop Avatar for kushaldas from gravatar.com kushaldas

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (GPLv3+)
  • Author: Kushal Das
  • Requires: Python >=3.5
Classifiers

Release history Release notifications | RSS feed

0.4.0

0.3.2

0.3.1

0.3.0

0.2.0

0.1.1

0.1.0

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

This version

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

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.7.tar.gz (19.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: securedrop-sdk-0.0.7.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for securedrop-sdk-0.0.7.tar.gz
Algorithm Hash digest
SHA256 ee1d51e33c6c4889aba78b44dee80bec6359a7ddcf75391df54090392379d58d
MD5 55691b4f692c027373cdb08b49db05fe
BLAKE2b-256 1d98d362fd1d5589881b7547489efdf711ae0c9764d9cd6a9a6c38418cc21b5b

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