Metadata-Version: 2.4
Name: channels_auth_token_middlewares
Version: 1.3.1
Summary: Django Channels auth token middlewares
Project-URL: Homepage, https://github.com/YegorDB/django-channels-auth-token-middlewares
Author-email: Yegor Bitensky <yegorbitensky@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: channels,django,middleware
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Requires-Python: >=3.8
Requires-Dist: channels>=4.1.0
Description-Content-Type: text/markdown

# Django Channels auth token middlewares

> Provides Django REST framework [token authentication](https://www.django-rest-framework.org/api-guide/authentication/#tokenauthentication) middleware, [Simple JWT](https://django-rest-framework-simplejwt.readthedocs.io/en/latest/index.html) middleware and easily extendable middlewares to work with auth tokens placed in request headers, cookie and query string.


## Requirements
- Channels>=4.1


## Install
1. `$ pip install channels-auth-token-middlewares`
2. Add app name to `INSTALLED_APPS`
```python
INSTALLED_APPS = [
    # base django apps (django.contrib.auth is required)
    # other apps this one depends on (like rest_framework if it's necessary)
    'channels_auth_token_middlewares',
    # custom apps
]
```

## Tutorial
[Explore](tutorial)


## Docs
[Explore](docs)


## Tests

### Requirements
- Docker>=19

### Usage

#### Run
`$ docker compose -f docker-compose.tests.yml up`

#### Clean
`$ docker compose -f docker-compose.tests.yml down`
