Metadata-Version: 2.1
Name: xdj-utils
Version: 0.0.6
Summary: a util set for django
Home-page: https://gitee.com/xdjango/xdj_utils.git
Author: 18580543261
Author-email: 595127207@qq.com
License: MIT Licence
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
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: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: asgiref (==3.3.4)
Requires-Dist: Django (==3.2.3)
Requires-Dist: django-filter (==2.4.0)
Requires-Dist: djangorestframework (==3.12.4)
Requires-Dist: djangorestframework-simplejwt (==4.7.1)
Requires-Dist: pytz (==2021.1)
Requires-Dist: six (==1.16.0)
Requires-Dist: user-agents (==2.2.0)
Requires-Dist: drf-yasg (==1.20.0)
Requires-Dist: gitpython (==3.1.20)
Requires-Dist: whitenoise (==5.3.0)

#usage
##install
```
pip install xdj-utils
```
##setting
###additional
```
USERNAME_FIELD = 'username'
ROLE_MODEL = 'xdj_system.Role'
DEFAULT_ROLE = ['']
ANONYMOUS_ROLE = ['']
```
###modification
```
USERNAME_FIELD = 'username'
ROLE_MODEL = 'xdj_system.Role'
DEFAULT_ROLE = ['']
ANONYMOUS_ROLE = ['']

#settings for modifying
MIDDLEWARE = [
    ...
    xdj_utils.middleware.ApiLoggingMiddleware
]

REST_FRAMEWORK = {
    ...
    'DEFAULT_FILTER_BACKENDS':(
        'xdj_utils.filters.CustomDjangoFilterBackend',
        ...
    ),
    'DEFAULT_PAGINATION_CLASS': 'xdj_utils.pagination.CustomPagination',
    'DEFAULT_AUTHENTICATION_CLASSES':(
        ...
        'xdj_utils.authentications.AnonymousAuthenticated',
    ),
    'EXCEPTION_HANDLER': 'xdj_utils.exception.CustomExceptionHandler',
}

AUTHENTICATION_BACKENDS = [
    'xdj_utils.backends.CustomBackend',
    ...
]

SWAGGER_SETTINGS = {
    ...
    'DEFAULT_AUTO_SCHEMA_CLASS': 'xdj_utils.swagger.CustomSwaggerAutoSchema',
}
```

