memberful 0.1.0__tar.gz

memberful-0.1.0/.gitignore

@@ -0,0 +1,170 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is not recommended to check the .idea/ directory into version control.
+.idea/
+.vscode/
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+settings.json

memberful-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michael Kennedy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

memberful-0.1.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: memberful
+Version: 0.1.0
+Summary: Memberful service Python client for webhooks and API
+Project-URL: Homepage, https://github.com/mikeckennedy/memberful
+Project-URL: Repository, https://github.com/mikeckennedy/memberful.git
+Project-URL: Issues, https://github.com/mikeckennedy/memberful/issues
+Project-URL: Changelog, https://github.com/mikeckennedy/memberful/blob/main/CHANGELOG.md
+Author: Michael Kennedy
+Maintainer: Michael Kennedy
+License: MIT License
+        
+        Copyright (c) 2025 Michael Kennedy
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: api,memberful,membership,subscription,webhooks
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: stamina>=24.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.7.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Memberful Python SDK
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Pydantic v2](https://img.shields.io/badge/Pydantic-v2-brightgreen.svg)](https://docs.pydantic.dev/)
+
+A modern, type-safe Python SDK for integrating with [Memberful](https://memberful.com)'s API and webhooks. Built with Pydantic models for comprehensive type hints and runtime validation.
+
+## ✨ Key Features
+
+- **🔒 Type Safety**: Full Pydantic model coverage for all API responses and webhook events
+- **🚀 Async First**: Built on `httpx` for high-performance async operations
+- **⚡ GraphQL Powered**: Efficient data fetching with Memberful's GraphQL API
+- **🔄 Resilient**: Smart retry logic with exponential backoff handles network hiccups and rate limits automatically
+- **📝 Auto-Complete Heaven**: Comprehensive type hints mean your IDE knows exactly what's available
+- **🎯 Zero Guesswork**: No more digging through API docs to figure out response formats
+- **🪝 Webhook Support**: Parse and validate webhook events with confidence
+- **📚 Rich Documentation**: Detailed examples and comprehensive API documentation
+- **🧪 Battle-Tested**: Extensive test suite ensures reliability
+- **🐍 Modern Python**: Supports Python 3.10+ with all the latest features
+
+## 📦 Installation
+
+```bash
+uv pip install memberful
+```
+
+Or with uv project management:
+
+```bash
+uv add memberful
+```
+
+## 🚀 Quick Start
+
+### API Client
+
+```python
+from memberful.api import MemberfulClient
+
+# Initialize the client
+async with MemberfulClient(api_key="YOUR_API_KEY") as client:
+    # Get all members with full type safety
+    members = await client.get_all_members()
+    
+    for member in members:
+        print(f"{member.full_name} - {member.email}")
+        
+        # Your IDE provides auto-complete for all attributes!
+        if member.subscriptions:
+            active_subs = [s for s in member.subscriptions if s.active]
+            print(f"  Active subscriptions: {len(active_subs)}")
+```
+
+### Webhook Handling
+
+```python
+from memberful.webhooks import (
+    parse_payload, 
+    validate_signature,
+    MemberSignupEvent,
+    SubscriptionCreatedEvent
+)
+import json
+
+def handle_webhook(request_body: str, signature_header: str, webhook_secret: str):
+    # Verify the webhook signature
+    if not validate_signature(
+        payload=request_body,
+        signature=signature_header,
+        secret_key=webhook_secret
+    ):
+        raise ValueError("Invalid webhook signature")
+    
+    # Parse the event with full type safety
+    event = parse_payload(json.loads(request_body))
+    
+    # Handle different event types with isinstance checks
+    match event:
+        case MemberSignupEvent():
+            print(f"New member: {event.member.email}")
+        case SubscriptionCreatedEvent():
+            print(f"New subscription for: {event.member.email}")
+        case _:
+            print(f"Received {event.event} event")
+```
+
+## 📖 Documentation
+
+### Comprehensive Guides
+
+- **[API Documentation](reference/api.md)** - Complete guide to using the API client with examples
+- **[Webhook Documentation](reference/webhooks.md)** - Detailed webhook event reference and handling guide
+
+### Quick Examples
+
+Check out the [examples directory](examples/) for ready-to-run code:
+- [Basic API Usage](examples/basic_api_usage.py) - Simple examples to get started
+- [Webhook Usage](examples/basic_webhook_usage.py) - Webhook handling patterns
+- [Webhook Parsing](examples/webhook_parsing.py) - Detailed webhook parsing examples
+- [FastAPI Integration](examples/fastapi_webhook_example/) - Complete FastAPI webhook server
+
+## 🛠️ Core Features
+
+### API Client Capabilities
+
+- ✅ Fetch members (individual, paginated, or all)
+- ✅ Retrieve subscriptions with full plan details
+- ✅ Automatic pagination handling
+- ✅ **Smart retry logic** with exponential backoff (3 attempts, handles network errors)
+- ✅ Configurable timeouts and retries
+- ✅ Type-safe responses with Pydantic models
+- ✅ Comprehensive error handling
+
+### Webhook Features
+
+- ✅ Type-safe parsing of all webhook event types
+- ✅ Automatic signature verification
+- ✅ Support for all 16 Memberful webhook events:
+  - **Member events**: signup, updated, deleted
+  - **Subscription events**: created, updated, activated, deleted, renewed
+  - **Order events**: completed, suspended
+  - **Plan events**: created, updated, deleted
+  - **Download events**: created, updated, deleted
+- ✅ Pydantic models for each event type
+- ✅ Helper functions for event handling
+
+## 🏗️ Architecture
+
+This SDK is built with modern Python best practices:
+
+- **GraphQL API** - leverages Memberful's GraphQL endpoint for efficient data fetching
+- **Async/await** for efficient I/O operations
+- **Pydantic v2** for fast data validation and serialization
+- **Type hints** throughout for better IDE support
+- **Minimal dependencies** - just `httpx`, `pydantic`, and `stamina` for resilient retries
+- **100% test coverage** for reliability
+
+## 🧪 Testing
+
+The SDK includes a comprehensive test suite. Run tests with:
+
+```bash
+# Install dev dependencies
+uv pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=memberful
+```
+
+## 🤝 Contributing
+
+We love contributions! If you've found a bug or have a feature request:
+
+1. **Check existing issues** first to avoid duplicates
+2. **Open an issue** to discuss the change
+3. **Submit a PR** with your improvements
+
+### Development Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/mikeckennedy/memberful.git
+cd memberful
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+uv pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+ruff format
+
+# Run linter
+ruff check
+```
+
+## 📊 Project Status
+
+This SDK is under active development and currently supports:
+
+- ✅ Member operations (read)
+- ✅ Subscription operations (read)
+- ✅ All webhook event types
+- ✅ Signature verification
+- ⏳ Member operations (create/update) - coming soon
+- ✅ GraphQL API integration with automatic retries
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built with ❤️ for the [Memberful](https://memberful.com) community
+- Inspired by modern Python SDK design patterns
+- Special thanks to all contributors
+
+## 📬 Support
+
+- 📖 [Read the documentation](reference/)
+- 🐛 [Report bugs](https://github.com/mikeckennedy/memberful/issues)
+- 💡 [Request features](https://github.com/mikeckennedy/memberful/issues)
+- 💬 [Discussions](https://github.com/mikeckennedy/memberful/discussions)
+
+---
+
+**Ready to integrate Memberful into your Python application? [Get started now!](#-quick-start)**

memberful-0.1.0/README.md

@@ -0,0 +1,216 @@
+# Memberful Python SDK
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Pydantic v2](https://img.shields.io/badge/Pydantic-v2-brightgreen.svg)](https://docs.pydantic.dev/)
+
+A modern, type-safe Python SDK for integrating with [Memberful](https://memberful.com)'s API and webhooks. Built with Pydantic models for comprehensive type hints and runtime validation.
+
+## ✨ Key Features
+
+- **🔒 Type Safety**: Full Pydantic model coverage for all API responses and webhook events
+- **🚀 Async First**: Built on `httpx` for high-performance async operations
+- **⚡ GraphQL Powered**: Efficient data fetching with Memberful's GraphQL API
+- **🔄 Resilient**: Smart retry logic with exponential backoff handles network hiccups and rate limits automatically
+- **📝 Auto-Complete Heaven**: Comprehensive type hints mean your IDE knows exactly what's available
+- **🎯 Zero Guesswork**: No more digging through API docs to figure out response formats
+- **🪝 Webhook Support**: Parse and validate webhook events with confidence
+- **📚 Rich Documentation**: Detailed examples and comprehensive API documentation
+- **🧪 Battle-Tested**: Extensive test suite ensures reliability
+- **🐍 Modern Python**: Supports Python 3.10+ with all the latest features
+
+## 📦 Installation
+
+```bash
+uv pip install memberful
+```
+
+Or with uv project management:
+
+```bash
+uv add memberful
+```
+
+## 🚀 Quick Start
+
+### API Client
+
+```python
+from memberful.api import MemberfulClient
+
+# Initialize the client
+async with MemberfulClient(api_key="YOUR_API_KEY") as client:
+    # Get all members with full type safety
+    members = await client.get_all_members()
+    
+    for member in members:
+        print(f"{member.full_name} - {member.email}")
+        
+        # Your IDE provides auto-complete for all attributes!
+        if member.subscriptions:
+            active_subs = [s for s in member.subscriptions if s.active]
+            print(f"  Active subscriptions: {len(active_subs)}")
+```
+
+### Webhook Handling
+
+```python
+from memberful.webhooks import (
+    parse_payload, 
+    validate_signature,
+    MemberSignupEvent,
+    SubscriptionCreatedEvent
+)
+import json
+
+def handle_webhook(request_body: str, signature_header: str, webhook_secret: str):
+    # Verify the webhook signature
+    if not validate_signature(
+        payload=request_body,
+        signature=signature_header,
+        secret_key=webhook_secret
+    ):
+        raise ValueError("Invalid webhook signature")
+    
+    # Parse the event with full type safety
+    event = parse_payload(json.loads(request_body))
+    
+    # Handle different event types with isinstance checks
+    match event:
+        case MemberSignupEvent():
+            print(f"New member: {event.member.email}")
+        case SubscriptionCreatedEvent():
+            print(f"New subscription for: {event.member.email}")
+        case _:
+            print(f"Received {event.event} event")
+```
+
+## 📖 Documentation
+
+### Comprehensive Guides
+
+- **[API Documentation](reference/api.md)** - Complete guide to using the API client with examples
+- **[Webhook Documentation](reference/webhooks.md)** - Detailed webhook event reference and handling guide
+
+### Quick Examples
+
+Check out the [examples directory](examples/) for ready-to-run code:
+- [Basic API Usage](examples/basic_api_usage.py) - Simple examples to get started
+- [Webhook Usage](examples/basic_webhook_usage.py) - Webhook handling patterns
+- [Webhook Parsing](examples/webhook_parsing.py) - Detailed webhook parsing examples
+- [FastAPI Integration](examples/fastapi_webhook_example/) - Complete FastAPI webhook server
+
+## 🛠️ Core Features
+
+### API Client Capabilities
+
+- ✅ Fetch members (individual, paginated, or all)
+- ✅ Retrieve subscriptions with full plan details
+- ✅ Automatic pagination handling
+- ✅ **Smart retry logic** with exponential backoff (3 attempts, handles network errors)
+- ✅ Configurable timeouts and retries
+- ✅ Type-safe responses with Pydantic models
+- ✅ Comprehensive error handling
+
+### Webhook Features
+
+- ✅ Type-safe parsing of all webhook event types
+- ✅ Automatic signature verification
+- ✅ Support for all 16 Memberful webhook events:
+  - **Member events**: signup, updated, deleted
+  - **Subscription events**: created, updated, activated, deleted, renewed
+  - **Order events**: completed, suspended
+  - **Plan events**: created, updated, deleted
+  - **Download events**: created, updated, deleted
+- ✅ Pydantic models for each event type
+- ✅ Helper functions for event handling
+
+## 🏗️ Architecture
+
+This SDK is built with modern Python best practices:
+
+- **GraphQL API** - leverages Memberful's GraphQL endpoint for efficient data fetching
+- **Async/await** for efficient I/O operations
+- **Pydantic v2** for fast data validation and serialization
+- **Type hints** throughout for better IDE support
+- **Minimal dependencies** - just `httpx`, `pydantic`, and `stamina` for resilient retries
+- **100% test coverage** for reliability
+
+## 🧪 Testing
+
+The SDK includes a comprehensive test suite. Run tests with:
+
+```bash
+# Install dev dependencies
+uv pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=memberful
+```
+
+## 🤝 Contributing
+
+We love contributions! If you've found a bug or have a feature request:
+
+1. **Check existing issues** first to avoid duplicates
+2. **Open an issue** to discuss the change
+3. **Submit a PR** with your improvements
+
+### Development Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/mikeckennedy/memberful.git
+cd memberful
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+uv pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+ruff format
+
+# Run linter
+ruff check
+```
+
+## 📊 Project Status
+
+This SDK is under active development and currently supports:
+
+- ✅ Member operations (read)
+- ✅ Subscription operations (read)
+- ✅ All webhook event types
+- ✅ Signature verification
+- ⏳ Member operations (create/update) - coming soon
+- ✅ GraphQL API integration with automatic retries
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built with ❤️ for the [Memberful](https://memberful.com) community
+- Inspired by modern Python SDK design patterns
+- Special thanks to all contributors
+
+## 📬 Support
+
+- 📖 [Read the documentation](reference/)
+- 🐛 [Report bugs](https://github.com/mikeckennedy/memberful/issues)
+- 💡 [Request features](https://github.com/mikeckennedy/memberful/issues)
+- 💬 [Discussions](https://github.com/mikeckennedy/memberful/discussions)
+
+---
+
+**Ready to integrate Memberful into your Python application? [Get started now!](#-quick-start)**