Metadata-Version: 2.2
Name: usageflow-core
Version: 0.3.3
Summary: Core functionality for UsageFlow - Usage-based pricing made simple
Home-page: https://github.com/usageflow/usageflow-python
Author: UsageFlow
Author-email: ronen@usageflow.io
Classifier: Development Status :: 4 - Beta
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.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: websocket-client>=1.6.0
Requires-Dist: PyJWT>=2.0.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# UsageFlow Core

> ⚠️ **Beta Notice**: This package is currently in beta. While we strive to maintain stability, there may be breaking changes as we continue to improve the API.

The core package of UsageFlow provides the fundamental functionality for API usage tracking and management. It contains the base client implementation and shared utilities used by framework-specific packages.

## Installation

```bash
pip install usageflow-core
```

## Features

- Base client implementation

## Usage

While you typically won't use this package directly (instead using framework-specific packages like `usageflow-flask` or `usageflow-fastapi`), here's how you can use the core client:

```python
from usageflow.core import UsageFlowClient

client = UsageFlowClient(api_key="your_api_key_here")

# Track a request
client.track_request(
    method="GET",
    path="/api/v1/users",
    identity="user123",
    metadata={"user_agent": "Mozilla/5.0"}
)
```

## Development

To contribute to the project:

1. Clone the repository
2. Install development dependencies:
   ```bash
   pip install -e ".[dev]"
   ```
3. Run tests:
   ```bash
   pytest
   ```

## License

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