Skip to main content

Asynchronous Python SDK for the Loyverse API

Project description

Loyverse SDK

Asynchronous Python SDK, CLI, and MCP server for the Loyverse API — a point-of-sale (POS) platform for managing sales, inventory, and customers.

Features

  • Async/await client built on httpx for non-blocking API calls
  • Type-safe request/response models powered by Pydantic
  • Automatic pagination with cursor-based iter_all() iteration
  • Full CRUD across 16 endpoints
  • loyverse CLI — list, create, update, delete, export, and analyze from the terminal
  • loyverse-mcp server — 18 read-only tools exposing your POS data to LLM clients (Claude Desktop, etc.)
  • DuckDB export — a local relational warehouse for SQL analytics
  • Flat-file export — write any query straight to CSV or Parquet
  • Analytics engine — revenue, products, customers, profitability, inventory, and more

Install

uv add loyverse_sdk          # core SDK
uv add "loyverse_sdk[mcp]"   # with the MCP server

See Installation for pip, GitHub, and extras.

Quickstart

import asyncio
from loyverse_sdk import LoyverseClient

async def main():
    client = LoyverseClient()                 # reads your token from ~/.loyverse
    response = await client.customers.list()
    print(f"Found {len(response.items)} customers")
    await client.close()

asyncio.run(main())

Run loyverse init once to store your API token. See Configuration and Quickstart to get going.

Documentation

Full documentation lives in the docs/ wiki — start at Home. Highlights:

The pages under docs/ use [[wikilink]] syntax so they render as a connected GitHub Wiki. When browsing them in the repo, use the relative links above.

License

MIT — see LICENSE.

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

loyverse_sdk-0.4.3.tar.gz (203.7 kB view details)

Uploaded Source

File details

Details for the file loyverse_sdk-0.4.3.tar.gz.

File metadata

  • Download URL: loyverse_sdk-0.4.3.tar.gz
  • Upload date:
  • Size: 203.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"21.3","id":"virginia","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for loyverse_sdk-0.4.3.tar.gz
Algorithm Hash digest
SHA256 5877589bf36913c1884871d8280111eeecbc840f56d85058c60a6d707316d61b
MD5 d305b6d3ec71dace0e05008a9e72d3a7
BLAKE2b-256 8d4ce33a89e728a3cf972ed1e500e5c88ba5df96ee85ee82aa666bfb6ba72a54

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