Skip to main content

Python library for Passbolt, an open-source manager for teams

Project description

👩  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 -



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 python script.

Environment variables


  • 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


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


Install gnu-sed with brew:

$ brew install gnu-sed

Use gsed instead of sed:

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

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

py-passbolt-0.0.17.tar.gz (7.7 kB view hashes)

Uploaded Source

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