Skip to main content

Python SDK for plaud.ai API

Project description

Plaud AI API client 📓

PyPI PyPI - Python Version PyPI - License


Documentation: https://docs.plaud.ai/documentation/get_started/overview

Source Code: https://github.com/DmytroLitvinov/python-plaud-ai

PyPI: https://pypi.org/project/plaud-ai/


Python API wrapper around Plaud AI API. Feel free to contribute and make it better! 🚀

Installation

pip install plaud-ai

Usage

  1. Request creating APP for you via Plaud API Survey (taken link from documentation)
# Example of using Plaud AI API to generate API token
from plaud_ai import PlaudAIAPIClient

client_id = 'xxxxxxxxxxxxxxx'
secret_key = 'yyyyyyyyyyyyyyy'

plaud_ai = PlaudAIAPIClient()
token_response = plaud_ai.api_token.generate_token(client_id, secret_key)
print(token_response.data, token_response.response_code)
api_token = token_response.data['api_token']

# Example of using Plaud AI API client to list devices
from plaud_ai import PlaudAIAPIClient

api_token = 'xxxxxxxxxxxxxxx'

plaud_ai = PlaudAIAPIClient(api_token)

devices_response = plaud_ai.devices_api.list()
print(devices_response.data, devices_response.response_code)

Webhooks

import json

from plaud_ai import is_valid_signature

payload_body = json.dumps(request.json).encode('utf-8')
signature_header = request.headers.get('Plaud-Signature')
webhook_secret = 'your_webhook_secret'

res = is_valid_signature(payload_body, signature_header, webhook_secret)

License

This project is licensed under the terms of the MIT license.

HOW TO MAKE A RELEASE

  • Add changes to CHANGELOG.md
  • Change version in plaud_ai/__init__.py and pyproject.toml
  • source .venv/bin/activate
  • python3 -m build --sdist --wheel
  • twine upload dist/*

Could be issues with license-file and other. Run next command to fix it:

  • pip install -U twine setuptools packaging build

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

plaud_ai-0.1.1.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plaud_ai-0.1.1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file plaud_ai-0.1.1.tar.gz.

File metadata

  • Download URL: plaud_ai-0.1.1.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for plaud_ai-0.1.1.tar.gz
Algorithm Hash digest
SHA256 450cf95f0640b65180d874c6b433812a79f7996e11343d91560e386d373d3dee
MD5 248e03e480f3885ac653b19956f10807
BLAKE2b-256 b6fc732bb328218017a2e468e3a00db5fb186efe576156567f28ad8532960169

See more details on using hashes here.

File details

Details for the file plaud_ai-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: plaud_ai-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for plaud_ai-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 07ba871512652d70688bd37a34b52a5ae38979f9e443ee852fcbe5ba9db493d9
MD5 642022d9a4ce15777e5fbc9c8285eaff
BLAKE2b-256 c762ee04e4de08ca18f8b41ed3f01435762b9ef137c81a1b62c3b47e33b7e197

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page