Metadata-Version: 2.1
Name: judoscale-python
Version: 0.0.2
Summary: Official Python adapter for Judoscale—the advanced autoscaler for Heroku
Home-page: https://github.com/judoscale/judoscale-python
Author: Adam McCrea
Author-email: adam@adamlogic.com
License: UNKNOWN
Project-URL: Issue Tracker, https://github.com/judoscale/judoscale-python/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# judoscale-python

This is the official Python adapter for Judoscale. You can use Judoscale without it, but this gives you request queue time metrics and job queue time (for supported job processors).

## Installation

```
pip install judoscale-python
```

## Supported web frameworks

- [x] Django
- [ ] Flask
- [ ] FastAPI

## Supported job processors

- [ ] Celery
- [ ] RQ

## Using Judoscale with Django

Add Judoscale app to `settings.py`:

```python
INSTALLED_APPS = [
    "judoscale.django",
    # ... other apps
]
```

Customize Judoscale options in `settings.py` (optional):

```python
JUDOSCALE = {
    # LOG_LEVEL defaults to ENV["LOG_LEVEL"] or "INFO".
    'LOG_LEVEL': 'DEBUG',

    # API_BASE_URL defaults to ENV["JUDOSCALE_URL"], which is set for you when you install Judoscale.
    # This is only exposed for testing purposes.
    'API_BASE_URL': 'https://example.com',

    # REPORT_INTERVAL_SECONDS defaults to 10 seconds.
    'REPORT_INTERVAL_SECONDS': 5,
}
```

Once deployed, you will see your "request queue time" metrics available in the Judoscale UI.


