https://github.com/passbolt/lab-passbolt-py
Python library for Passbolt API
https://github.com/passbolt/lab-passbolt-py
Last synced: about 1 year ago
JSON representation
Python library for Passbolt API
- Host: GitHub
- URL: https://github.com/passbolt/lab-passbolt-py
- Owner: passbolt
- License: mit-0
- Created: 2022-04-06T14:05:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-13T10:23:52.000Z (over 2 years ago)
- Last Synced: 2024-11-10T13:43:39.786Z (over 1 year ago)
- Language: Python
- Homepage: https://passbolt.com
- Size: 76.2 KB
- Stars: 8
- Watchers: 7
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
👩 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](https://www.python-httpx.org/) and [PGPy](https://pgpy.readthedocs.io/en/latest/).
You can also use [python-gnupg](https://docs.red-dove.com/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](https://gitlab.com/AnatomicJC/py-passbolt/-/blob/main/config.json.PGPy.sample)
* For python-gnupg: [config.json.gnupg.sample](https://gitlab.com/AnatomicJC/py-passbolt/-/blob/main/config.json.gnupg.sample)
Then have a look at [https://gitlab.com/AnatomicJC/py-passbolt/-/blob/main/example.py](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
```