lemonsqueezy


Namelemonsqueezy JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryLemonSqueezy-py-api is an unofficial Python library for interacting with the LemonSqueezy API.
upload_time2024-12-08 02:19:23
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LemonSqueezy Py API

An unofficial Python SDK for the LemonSqueezy API. Simplify your integration with LemonSqueezy's platform to manage license keys, checkouts, webhooks, usage records, discounts, and more.

[![Leave a star](https://img.shields.io/github/stars/wdonofrio/lemonsqueezy-py-api?style=social)](https://github.com/wdonofrio/lemonsqueezy-py-api)

## Features

- 🔑 License Key Management
- 💳 Checkout & Payment Processing
- 🔔 Webhook Integration
- 📊 Usage Tracking
- 🏷️ Discount Management
- 🏪 Store & Product Management
- 👥 Customer Data Access
- 📦 Digital File Management

## Installation

```sh
pip install lemonsqueezy
```

## Quick Start

Initialize the client with your API key:

```python
from lemonsqueezy import LemonSqueezy

client = LemonSqueezy(api_key="your_api_key")
```

### Examples

```python
# List all your stores
stores = client.list_stores()

# Get customer information
customers = client.list_customers()

# Manage products
product = client.get_product(123)
all_products = client.list_products()
product_variants = client.get_product_variants(123)

# Handle digital files
file = client.get_file(456)
all_files = client.list_files()

# Work with variants
variant = client.get_variant(789)
all_variants = client.list_variants()
```

## Configuration

You can configure the client using environment variables:

```env
LEMONSQUEEZY_API_KEY=your_api_key
LEMONSQUEEZY_API_URL=https://api.lemonsqueezy.com/v1  # Optional
```

Or pass configuration directly to the client:

```python
client = LemonSqueezy(
    api_key="your_api_key",
    api_url="https://api.lemonsqueezy.com/v1"  # Optional
)
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

See [CONTRIBUTING](CONTRIBUTING.md) for more details.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Support

- 🌟 Star this repo to show your support
- 🐛 Open an issue to report bugs
- 💡 Open an issue to request features
- 📖 Documentation coming soon!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "lemonsqueezy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/db/3e/4e329dfd0425b86dcc23d4a639ae47c95130fa02a039571bece4f8a05234/lemonsqueezy-0.1.1.tar.gz",
    "platform": null,
    "description": "# LemonSqueezy Py API\n\nAn unofficial Python SDK for the LemonSqueezy API. Simplify your integration with LemonSqueezy's platform to manage license keys, checkouts, webhooks, usage records, discounts, and more.\n\n[![Leave a star](https://img.shields.io/github/stars/wdonofrio/lemonsqueezy-py-api?style=social)](https://github.com/wdonofrio/lemonsqueezy-py-api)\n\n## Features\n\n- \ud83d\udd11 License Key Management\n- \ud83d\udcb3 Checkout & Payment Processing\n- \ud83d\udd14 Webhook Integration\n- \ud83d\udcca Usage Tracking\n- \ud83c\udff7\ufe0f Discount Management\n- \ud83c\udfea Store & Product Management\n- \ud83d\udc65 Customer Data Access\n- \ud83d\udce6 Digital File Management\n\n## Installation\n\n```sh\npip install lemonsqueezy\n```\n\n## Quick Start\n\nInitialize the client with your API key:\n\n```python\nfrom lemonsqueezy import LemonSqueezy\n\nclient = LemonSqueezy(api_key=\"your_api_key\")\n```\n\n### Examples\n\n```python\n# List all your stores\nstores = client.list_stores()\n\n# Get customer information\ncustomers = client.list_customers()\n\n# Manage products\nproduct = client.get_product(123)\nall_products = client.list_products()\nproduct_variants = client.get_product_variants(123)\n\n# Handle digital files\nfile = client.get_file(456)\nall_files = client.list_files()\n\n# Work with variants\nvariant = client.get_variant(789)\nall_variants = client.list_variants()\n```\n\n## Configuration\n\nYou can configure the client using environment variables:\n\n```env\nLEMONSQUEEZY_API_KEY=your_api_key\nLEMONSQUEEZY_API_URL=https://api.lemonsqueezy.com/v1  # Optional\n```\n\nOr pass configuration directly to the client:\n\n```python\nclient = LemonSqueezy(\n    api_key=\"your_api_key\",\n    api_url=\"https://api.lemonsqueezy.com/v1\"  # Optional\n)\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for more details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Support\n\n- \ud83c\udf1f Star this repo to show your support\n- \ud83d\udc1b Open an issue to report bugs\n- \ud83d\udca1 Open an issue to request features\n- \ud83d\udcd6 Documentation coming soon!\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "LemonSqueezy-py-api is an unofficial Python library for interacting with the LemonSqueezy API.",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ade5558376b66c1748c5dc7393852abab376a4b2ce55dc152f6183975c360a0c",
                "md5": "4cc4c73ebfb7dd92378a73b1127f7bec",
                "sha256": "2d502b15a7c092d966b3dfd0ec53b4863525cc999fc428cf6f8be98bed27b1aa"
            },
            "downloads": -1,
            "filename": "lemonsqueezy-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4cc4c73ebfb7dd92378a73b1127f7bec",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 16690,
            "upload_time": "2024-12-08T02:19:22",
            "upload_time_iso_8601": "2024-12-08T02:19:22.649217Z",
            "url": "https://files.pythonhosted.org/packages/ad/e5/558376b66c1748c5dc7393852abab376a4b2ce55dc152f6183975c360a0c/lemonsqueezy-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "db3e4e329dfd0425b86dcc23d4a639ae47c95130fa02a039571bece4f8a05234",
                "md5": "81d59f3716accf6c19c2e71a20992e52",
                "sha256": "71d5f1b398aa2795136e0799ed91fdb124ba6b340ecaf3deaf2ccf21ea59a318"
            },
            "downloads": -1,
            "filename": "lemonsqueezy-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "81d59f3716accf6c19c2e71a20992e52",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 64042,
            "upload_time": "2024-12-08T02:19:23",
            "upload_time_iso_8601": "2024-12-08T02:19:23.676278Z",
            "url": "https://files.pythonhosted.org/packages/db/3e/4e329dfd0425b86dcc23d4a639ae47c95130fa02a039571bece4f8a05234/lemonsqueezy-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-08 02:19:23",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "lemonsqueezy"
}
        
Elapsed time: 0.53162s