👩 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:
- For PGPy (default): config.json.PGPy.sample
- For python-gnupg: config.json.gnupg.sample
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
1 maintainer
Metadata
1 maintainer
Release files for py-passbolt 0.0.19
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| py_passbolt-0.0.19.tar.gz | 5.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| py_passbolt-0.0.19-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.7 kB
Release files / py_passbolt-0.0.19.tar.gz
| Download URL | py_passbolt-0.0.19.tar.gz |
|---|---|
| Size | 5.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
67be027d1359e930e64769e4b65eeddd0e17ea8ef4af27e2d821ba8bba1981bc
|
|
BLAKE2b-256 checksum How to use checksums |
fad4f79bc6a9da42e4ca3bab58539aed170526ba84db15a4d84712e179580a8a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.7
|
Release files / py_passbolt-0.0.19-py3-none-any.whl
| Download URL | py_passbolt-0.0.19-py3-none-any.whl |
|---|---|
| Size | 5.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3516280ace5f6b5cc9a751f733cd2dfb139ab2557b6fccfe7cfb2afee64ed89a
|
|
BLAKE2b-256 checksum How to use checksums |
903da98754fdab2cdc889fc17242a4e69194e0ee5da91c0ac0c9002ca43b4803
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.7
|
