Automatilib is common django code used by the i.AI team.
Project description
i.AI Shared Code
automatilib
is a django package used and developed by the i.AI team within the Cabinet Office.
It provides common features used in many of our applications.
Features
- Timestamped, UUID and base user models
- Initial migration for above models
- Logic for authenticating with COLA
Settings
LOGIN_REDIRECT_URL
- The URL to redirect users to post-loginLOGIN_URL
- The URL to redirect users to if they are not logged inCOLA_COOKIE_NAME
- The name of the cookie to check for COLA JWTCOLA_COGNITO_CLIENT_ID
- The cognito client ID found in AWSAWS_REGION_NAME
- The AWS region that the user pool and cognito client live inCOLA_COGNITO_USER_POOL_ID
- The cognito user pool ID in AWS
This is where some of the above can be found:
COLA_COOKIE_NAME
: In your json settings file for COLACOLA_COOKIE_DOMAIN
:cabinetoffice.gov.uk
COLA_COGNITO_CLIENT_ID
: In AWS, go to your cognito user pool, then to app integration, then at the bottom you can find your client ID in the tableAWS_REGION_NAME
: Whichever region in AWS your Cognito pool lives, likely to beeu-west-2
COLA_COGNITO_USER_POOL_ID
: In AWS, go to your cognito user pool, in the top table calledUser pool overview
, yourUser pool ID
is thereCOLA_LOGIN_URL
: Ask the COLA team for this URLCOLA_JWT_REGEX_PATTERN
: This is one you can adjust how you want to, the baseline is(?<=:).*(?=\.)
To make use of COLA
see the example settings in this repo
Add these into your INSTALLED_APPS
settings:
INSTALLED_APPS = [
"automatilib.core.apps.IdotAIConfig",
"automatilib.cola.apps.ColaAuthConfig",
...
]
Add this into your AUTHENTICATION_BACKEND
setting:
AUTHENTICATION_BACKENDS = [
"automatilib.cola.backend.COLAAuthenticationBackend",
"django.contrib.auth.backends.ModelBackend", # This includes the default backend
]
Import and add the following to your url_patterns:
from automatilib.cola.urls import url_patterns as cola_urls
urlpatterns = other_urlpatterns + cola_urls
How to run Tests
DJANGO_SETTINGS_MODULE=example_project.settings pytest --cov cola --cov core --cov-report term-missing --cov-fail-under 80
Licence
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
automatilib-1.0.3.tar.gz
(5.7 kB
view hashes)
Built Distribution
Close
Hashes for automatilib-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11d67880587af523b510228763e34c16b949a57062a543539d713213ad77d64b |
|
MD5 | 9f9c7a4aa789c1daa453b051d411f27f |
|
BLAKE2b-256 | 2828191484515a7a32424de419f9a4199d6868d5c6fdfc75e2cabdbc9a5aa23c |