| Name | django-cognito-lowlevel JSON |
| Version |
0.1.11
JSON |
| download |
| home_page | |
| Summary | Django authentication with AWS Cognito for your custom workflow |
| upload_time | 2023-06-09 15:44:43 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
cognito
django
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# django-cognito-lowlevel
**django-cognito-lowlevel** is a Django package for handling authentication with AWS Cognito in a lower level way.
This package does not make any attempts at integrating with the Django user system directly. Handler for your callback function is provided for your own workflow customizations.
---
## Installation of django-cognito-lowlevel
You can integrate **django-cognito-lowlevel** with your Django project using a Python virtual environment
Please use pip to install at your Python virtual environment:
`pip install django-cognito-lowlevel`
---
### Django settings that should and can be configured
The following variables are needed at the **settings.py** of your project.
| **Varaiable** | **Description & example** |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `COGNITO_USER_POOL_ID` | User pool ID of your AWS Cognito setup. <br />e.g. `"eu-west-XXXXXXXX"` |
| `COGNITO_CLIENT_ID` | Client ID of your AWS Cognito setup. <br />e.g. `"2vvdsdfr243rwefswe445rte5edr"` |
| `COGNITO_APP_CLIENT_SECRET` | Client Secret of AWS Cognito setup. <br />e.g. `1urj4uktvlmb0pps234234d6io8tipmrlu3se13fdssdf` |
| `COGNITO_TOKEN_URL` | The Token URL of your AWS Cognito setup. <br />e.g. `"https://<xxxxxxxxxx>.auth.<eu-west-2>.amazoncognito.com/oauth2/token"` |
| `COGNIT_CALLBACK_URL_PATH` | Call back path redirected from AWS Cognito. <br />e.g. `"some-folder-of-your-choice/api/cognito/userpool/callback/"` |
| `COGNITO_REDIRECT_URL` | Add some random delay of 1 to 30 seconds for each HTTP requests. Disable by default. <br />e.g.`f"http://localhost:8000/{COGNIT_CALLBACK_URL_PATH}"` |
| `COGNITO_HOST` | The host of your AWS Cognito setup. <br />e.g. `"<xxxxxxxxxx>.auth.<eu-west-2>.amazoncognito.com"` |
| `COGNITO_USERPOOL_REGION` | Default AWS Cognito region Name. <br />e.g.`"us-west-2"` |
| `COGNITO_AUTH_SUCCESS_REDIRECT_URL` | URL or Django URL route name of redirection upon success, after obtaining the `access_token` and `id_token`. <br />e.g. `"landing:index"` |
| `COGNITO_AUTH_ERROR_REDIRECT_URL` | URL or Django URL route name of redirection upon error. <br />e.g.`"landing:error"` |
| `COGNITO_PUBLIC_KEYS_CACHE_TIMEOUT` | Cache time of the public keys of your AWS Cognito setup. <br />e.g.`300` |
---
# Credits & Acknowledgements
### Python packages dependencies
- **awslabs/aws-support-tools**
Decode and verify Amazon Cognito JWT tokens
Copyright (c) Amazon Web Services - Labs
Apache-2.0 license
https://github.com/awslabs/aws-support-tools/tree/master/Cognito/decode-verify-jwt
- **Django**
Copyright (c) Django Software Foundation and individual contributors.
All rights reserved.
https://www.djangoproject.com/
- **Requests**
Copyright (c) Kenneth Reitz & Python Software Foundation
Apache-2.0 license
https://github.com/psf/requests
- **colorama**
Copyright Jonathan Hartley & Arnon Yaari, 2013-2020.
BSD-3-Clause license
https://github.com/tartley/colorama
- **python-jose**
Copyright (c) Michael Davis
MIT license
https://github.com/mpdavis/python-jose
---
## License
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Raw data
{
"_id": null,
"home_page": "",
"name": "django-cognito-lowlevel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "cognito,django",
"author": "",
"author_email": "Pulsely <python@pulsely.com>",
"download_url": "https://files.pythonhosted.org/packages/bb/c5/5e57398a14b1facb3ad5fdb515a703e747e9d940e5ec6ac963e51b32456b/django_cognito_lowlevel-0.1.11.tar.gz",
"platform": null,
"description": "# django-cognito-lowlevel\n\n**django-cognito-lowlevel** is a Django package for handling authentication with AWS Cognito in a lower level way.\n\nThis package does not make any attempts at integrating with the Django user system directly. Handler for your callback function is provided for your own workflow customizations.\n\n---\n\n## Installation of django-cognito-lowlevel\n\nYou can integrate **django-cognito-lowlevel** with your Django project using a Python virtual environment\nPlease use pip to install at your Python virtual environment:\n\n`pip install django-cognito-lowlevel`\n\n---\n\n### Django settings that should and can be configured\n\nThe following variables are needed at the **settings.py** of your project.\n\n| **Varaiable** | **Description & example** |\n| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `COGNITO_USER_POOL_ID` | User pool ID of your AWS Cognito setup. <br />e.g. `\"eu-west-XXXXXXXX\"` |\n| `COGNITO_CLIENT_ID` | Client ID of your AWS Cognito setup. <br />e.g. `\"2vvdsdfr243rwefswe445rte5edr\"` |\n| `COGNITO_APP_CLIENT_SECRET` | Client Secret of AWS Cognito setup. <br />e.g. `1urj4uktvlmb0pps234234d6io8tipmrlu3se13fdssdf` |\n| `COGNITO_TOKEN_URL` | The Token URL of your AWS Cognito setup. <br />e.g. `\"https://<xxxxxxxxxx>.auth.<eu-west-2>.amazoncognito.com/oauth2/token\"` |\n| `COGNIT_CALLBACK_URL_PATH` | Call back path redirected from AWS Cognito. <br />e.g. `\"some-folder-of-your-choice/api/cognito/userpool/callback/\"` |\n| `COGNITO_REDIRECT_URL` | Add some random delay of 1 to 30 seconds for each HTTP requests. Disable by default. <br />e.g.`f\"http://localhost:8000/{COGNIT_CALLBACK_URL_PATH}\"` |\n| `COGNITO_HOST` | The host of your AWS Cognito setup. <br />e.g. `\"<xxxxxxxxxx>.auth.<eu-west-2>.amazoncognito.com\"` |\n| `COGNITO_USERPOOL_REGION` | Default AWS Cognito region Name. <br />e.g.`\"us-west-2\"` |\n| `COGNITO_AUTH_SUCCESS_REDIRECT_URL` | URL or Django URL route name of redirection upon success, after obtaining the `access_token` and `id_token`. <br />e.g. `\"landing:index\"` |\n| `COGNITO_AUTH_ERROR_REDIRECT_URL` | URL or Django URL route name of redirection upon error. <br />e.g.`\"landing:error\"` |\n| `COGNITO_PUBLIC_KEYS_CACHE_TIMEOUT` | Cache time of the public keys of your AWS Cognito setup. <br />e.g.`300` |\n\n---\n\n# Credits & Acknowledgements\n\n### Python packages dependencies\n\n- **awslabs/aws-support-tools** \n Decode and verify Amazon Cognito JWT tokens \n Copyright (c) Amazon Web Services - Labs\n Apache-2.0 license\n https://github.com/awslabs/aws-support-tools/tree/master/Cognito/decode-verify-jwt\n\n- **Django** \n Copyright (c) Django Software Foundation and individual contributors. \n All rights reserved. \n https://www.djangoproject.com/\n\n- **Requests** \n Copyright (c) Kenneth Reitz & Python Software Foundation\n Apache-2.0 license\n https://github.com/psf/requests\n\n- **colorama** \n Copyright Jonathan Hartley & Arnon Yaari, 2013-2020.\n BSD-3-Clause license\n https://github.com/tartley/colorama\n\n- **python-jose** \n Copyright (c) Michael Davis\n MIT license\n https://github.com/mpdavis/python-jose\n\n---\n\n## License\n\nApache License\nVersion 2.0, January 2004\nhttp://www.apache.org/licenses/\n",
"bugtrack_url": null,
"license": "",
"summary": "Django authentication with AWS Cognito for your custom workflow",
"version": "0.1.11",
"project_urls": {
"Bug Tracker": "https://github.com/pulsely/django-cognito-lowlevel/issues",
"Homepage": "https://github.com/pulsely/django-cognito-lowlevel"
},
"split_keywords": [
"cognito",
"django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01aa205ce6ec4010d5076379fececdebf2cd0dcdb2ac144153138ceb7c65dc3f",
"md5": "5176521694e97763bf0d2a8d1286887d",
"sha256": "090e791408cf1d1ccf9c50197e4eb8711ef303dc98912338e6f91871f59a4980"
},
"downloads": -1,
"filename": "django_cognito_lowlevel-0.1.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5176521694e97763bf0d2a8d1286887d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10858,
"upload_time": "2023-06-09T15:44:41",
"upload_time_iso_8601": "2023-06-09T15:44:41.591413Z",
"url": "https://files.pythonhosted.org/packages/01/aa/205ce6ec4010d5076379fececdebf2cd0dcdb2ac144153138ceb7c65dc3f/django_cognito_lowlevel-0.1.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbc55e57398a14b1facb3ad5fdb515a703e747e9d940e5ec6ac963e51b32456b",
"md5": "27ed179e7fc5e03bb6f9b8ce641997ca",
"sha256": "00354dd4b10c71af89b49d8adbc32632899898d7d47f9e2d26931773766cd9c9"
},
"downloads": -1,
"filename": "django_cognito_lowlevel-0.1.11.tar.gz",
"has_sig": false,
"md5_digest": "27ed179e7fc5e03bb6f9b8ce641997ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9303,
"upload_time": "2023-06-09T15:44:43",
"upload_time_iso_8601": "2023-06-09T15:44:43.301610Z",
"url": "https://files.pythonhosted.org/packages/bb/c5/5e57398a14b1facb3ad5fdb515a703e747e9d940e5ec6ac963e51b32456b/django_cognito_lowlevel-0.1.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-09 15:44:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pulsely",
"github_project": "django-cognito-lowlevel",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "django-cognito-lowlevel"
}
