Metadata-Version: 2.1
Name: django-drf-mjwt
Version: 0.0.1b2
Summary: A JWT authentication to django project
Home-page: https://github.com/milemik/django-drf-jwt
Author: Ivan Miletic
Author-email: milemik68@gmail.com
License: MIT
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# Django DRF JWT

Goal of this simple package is to create a simple JWT authentication for Django apps.
This should be easy to configue and easy to adapt to your needs and preferences.
Package is based on [PyJWT](https://github.com/jpadilla/pyjwt)


## Setup

1. Install package
    ```shell
    pip install django-drf-mjwt
    ```

2. Add django_drf_jwt to your INSTALLED_APPS:
   ```python
   INSTALLED_APPS = [
    # ...
    "django_drf_jwt",
    # ...
    ]
   ```

3. Update REST_FRAMEWORK settings:
    ```python
    REST_FRAMEWORK = {
        # ...
        "DEFAULT_AUTHENTICATION_CLASSES": (
            "django_drf_jwt.authentication.JWTAuthentication",
        )
        # ...
    }
    ```

4. Add new field in your User model and add this to your settings file
    ```python
    JWT_DRF = {
        # JWT_USER_SECRET_FIELD - MUST BE DEFINED - This must be filed in User object
        "JWT_USER_SECRET_FIELD": "secret",
    }
    ```

    Available settings:
    ```python
    # These are default settings
    JWT_DRF = {
        "JWT_SECRET": settings.SECRET_KEY,
        "JWT_USER_ID_FIELD": "pk",
        "JWT_USER_SECRET_FIELD": None,  # MUST BE DEFINED - This must be a
        "JWT_PAYLOAD_HANDLER": "django_drf_jwt.handlers.payload_handler",
        "JWT_AUTH_HEADER_PREFIX": "JWT",
    }
    ```


### Issues
Issues and bugs be free to contact me directly

### NOTE
I plan to push this package to PyPi when ready! :)
