Skip to main content

A python client for Passbolt.

Project description

Copyright (c) 2019 Dr. Shubham Dipt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Description: # Passbolt-python-API

## Installation

$pip install passbolt-python-api

## Dependencies

  • Python3

  • GPG (also known as GnuPG) software

## Configuration

Create a config file with the following contents.

[PASSBOLT] SERVER = http://<server_ip or domain> SERVER_PUBLIC_KEY_FILE = <optional: server_public.asc> USER_FINGERPRINT = <user_fingerprint> USER_PUBLIC_KEY_FILE = passbolt_public.asc USER_PRIVATE_KEY_FILE = passbolt_private.asc PASSPHRASE = <passbolt_password>

## Usage

>>>import passboltapi >>>passbolt = passboltapi.PassboltAPI(config_path=”config.ini”)

# Now you may do any get, post, put and delete request. >>>r = passbolt.get(url=”/resources.json?api-version=v2”) >>>r = passbolt.post(self.server_url + url, json=data)

# One can also use it as context manager >>>with passboltapi.PassboltAPI(config_path=”config.ini”) as passbolt:

Check test.py for an example.

### Passbolt API

For more API related questions, visit Passbolt API documentation:

<https://help.passbolt.com/api>

Platform: any Classifier: Programming Language :: Python :: 3 Classifier: License :: OSI Approved :: MIT License Classifier: Operating System :: OS Independent Description-Content-Type: text/markdown

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

passbolt-python-api-0.1.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

passbolt_python_api-0.1.1-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

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