Skip to main content

A modern Python API wrapper for Paddle's API with type hints and async support

Project description

Paddle SDK

A modern Python API wrapper for Paddle's API with type hints and async support.

License: MIT Python Version Code style: black

Features

  • 🚀 Synchronous and asynchronous client implementations
  • 📦 Support for Paddle's API (in development)
  • 🧩 Type hints throughout the codebase
  • 🔄 Automatic retry mechanism for failed requests
  • 🔧 Environment configuration (Sandbox/Production)
  • 🛡️ Comprehensive error handling
  • 📊 Extensive test coverage

Installation

pip install paddle.py

Quick Start

Synchronous Client

from paddle import Client, Environment

# Initialize the client
client = Client(
    api_key="API_KEY",
    environment=Environment.SANDBOX  # or Environment.PRODUCTION
)

# List products
products = client.products.list()
print(products)

# Get a specific product
product = client.products.get(product_id="pro_123456789")
print(product)

Asynchronous Client

import asyncio

from paddle.aio import AsyncClient
from paddle import Environment


async def main():
    async with AsyncClient(
        api_key="API_KEY",
        environment=Environment.SANDBOX,  # or Environment.PRODUCTION
    ) as client:
        # List products
        all_products = await client.products.list()
        print(all_products)

        # Get a product
        product = await client.products.get("pro_123456789")
        print(product)


if __name__ == "__main__":
    asyncio.run(main())

Development

Setup

  1. Clone the repository:
git clone https://github.com/CCXLV/paddle-sdk.git
cd paddle-sdk
  1. Create a virtual environment:
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. Install development dependencies:
pip install -e .[dev]

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=paddle

Contributing

For detailed information on how to contribute to this project, please see our Contributing Guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Roadmap

See the CHANGELOG.md for planned API endpoints and features.

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

paddle_py-0.1.0.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

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

paddle_py-0.1.0-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: paddle_py-0.1.0.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for paddle_py-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ca1b5136b690ffbdb57ec654eb0521ce37a503b4119b893016aa0ff8993f000b
MD5 f140803c19445731b0f061f4f397b6a1
BLAKE2b-256 323a75fd57ba3822c286ed67da0852e5b1239a754bc48443c8f37777c62e6c7e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: paddle_py-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 43.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for paddle_py-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02d28ccbd01b71800501da6d5db7c37cdee27693170ea909127df33bbef99657
MD5 aec1e9eeb7a91c3e5b95327613df8a81
BLAKE2b-256 cf67864def207ff1e3c1f1658c4fcb315062148d03a6e4b1d374ef158fee6edb

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