Skip to main content
👩  This project is part of the passbolt "lab"!
⚗️   It is used to illustrate an article or as a conversation starter.
🧪  Use at your own risks!

Copyright & License

(c) 2021 Passbolt SA

Passbolt is registered trademark of Passbolt S.A.

MIT No Attribution - https://opensource.org/licenses/MIT-0

py-passbolt

About

Python library for Passbolt API based on httpx and PGPy.

You can also use python-gnupg if needed but it is not the default.

How to install

python -m pip install py-passbolt

How to use

config.json configuration file

Basically, create a config.json file containing needed configuration. You will find samples:

Then have a look at https://gitlab.com/AnatomicJC/py-passbolt/-/blob/main/example.py python script.

Environment variables

Mandatory:

  • PASSBOLT_BASE_URL: Your passbolt URL

For PGPy:

  • PASSBOLT_PRIVATE_KEY: Your passbolt private key in one-line format (See below about how to format)
  • PASSBOLT_PASSPHRASE: Your passbolt passphrase

For python-gnupg:

  • PASSBOLT_GPG_BINARY (Optional): path to your gpg binary, default to "gpg"
  • PASSBOLT_GPG_LIBRARY: Set this to gnupg, otherwise it will be the default "PGPy"
  • PASSBOLT_FINGERPRINT: The OpenPGP key fingerprint to use

How to set OpenPGP key in config.json or environment variables

Linux:

sed -z 's/\n/\\n/g' private.asc

MacOS

Install gnu-sed with brew:

$ brew install gnu-sed

Use gsed instead of sed:

gsed -z 's/\n/\\n/g' private.asc

Metadata

Release files for py-passbolt 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-passbolt 0.0.9
File Size Uploaded Provenance Actions
py-passbolt-0.0.9.tar.gz 5.9 kB Without provenance Details for py-passbolt-0.0.9.tar.gz

Release files / py-passbolt-0.0.9.tar.gz

Download URL py-passbolt-0.0.9.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ceff1196be1be982316c21fdcbd870f32a6abb035f3334399b4f19841bcf3b1e
BLAKE2b-256 checksum
How to use checksums
5edcb247b3a3609ab5d6895fbc34252f84a05a62d59f88f79e4581e4f77ea821
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.12

Security for py-passbolt 0.0.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page