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! 🚀

NOTE: Since it is early release, some of the API endpoints may not be implemented yet. If you need some specific endpoint, feel free to create an issue or pull request. Also, library can be changed in the future, so be careful with the updates as for now.

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 .env/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.0.tar.gz (7.5 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.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plaud_ai-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 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.0.tar.gz
Algorithm Hash digest
SHA256 c82e0afdfab7470779f575957df306c6558c43fa7ee951b124fbfa2e14b442db
MD5 635eb75fe8216f668096fc74bd727713
BLAKE2b-256 73410271b602dfae8dc53c4478cd76be1bfb09f910fd291bee6e432549250c13

See more details on using hashes here.

File details

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

File metadata

  • Download URL: plaud_ai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a651f0d39d7558fcfb49638b936e60765d451eacc4333787bb70e814333e745
MD5 2285c1daeabde8337675b639c824d37c
BLAKE2b-256 43369cbd18a134d43998657a677c37a471a9fdb24234e144bd3feca0d07b6f54

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