Django-dysession is a simple and easy-to-use app which allow Django developers to take DyanmoDB as Session Backend Database.
DynamoDB is Fast, flexible NoSQL database service for single-digit millisecond performance at any scale.
Using DynamoDB for session storage alleviates issues that occur with session handling in a distributed web application by moving sessions off of the local file system and into a shared location. [[1]]
django-dysession use boto3 to interact with AWS DynamoDB. Boto3 is the Amazon Web Services (AWS) Software Development Kit (SDK) for Python, which allows Python developers to write software that makes use of services like DynamoDB.
Install from PyPI ( or manually download from PyPI ):
pip install -U django-dysession
First of all, add dysession
into INSTALLED_APPS
in settings.py.
Change SESSION_ENGINE
to dysession.backends.db
in order use our SessionStore.
INSTALLED_APPS = [
...
"dysession", # add dysession to installed apps
# 'django.contrib.sessions', # remove this default session
...
]
SESSION_ENGINE = "dysession.backends.db"
Second, we need to create a DynamoDB to store session data which's name is sessions
as default.
Run the commands bellow in cmd.
python manage.py dysession_init
Then, we can enjoy it now!
from django.http import HttpResponse
def mainpage(request):
request.session["is_admin"] = True
request.session["bottle_of_milks"] = 20
request.session["planet_have_been_to"] = ["Earth", "Jupiter", "Saturn"]
return HttpResponse("Ayyy")
Enjoy!
django-dysession offer two commands for developers:
python manage.py --help
Type 'manage.py help <subcommand>' for help on a specific subcommand.
Available subcommands:
[dysession]
dysession_destory
dysession_init
This section outlines all the settings and configurations that you can put in Django's settings.py to adjust dysession
's behavior.
You can overwrite any value in DYSESSION
or just ignore it to use the default value!
DYSESSION = {
"DYNAMODB_TABLENAME": "sessions",
"PARTITION_KEY_NAME": "PK",
"SORT_KEY_NAME": "SK",
"TTL_ATTRIBUTE_NAME": "ttl",
"CACHE_PERIOD": 3600,
"DYNAMODB_REGION": "ap-northeast-1",
"LOGGING": {
"TYPE": "CONSOLE",
},
}
Argument | Default | Description |
---|---|---|
DYNAMODB_TABLENAME | sessions | DynamoDB table name |
PARTITION_KEY_NAME | PK | Partition key name |
TTL_ATTRIBUTE_NAME | ttl | Time to live attribute name |
CACHE_PERIOD | 3600 | Define how long should be the cache live in DynamoDB's table |
DYNAMODB_REGION | ap-northeast-1 | The region of the DynamoDB table |
LOGGING | Dict | Configuration of Logging |
LOGGING["TYPE"] | CONSOLE | Only accept two kinds of parameters: CONSOLE , FILE . If this set to CONSOLE , django-dysession will use StreamHandler to stream to the console. If this set to FILE , django-dysession will use FileHandler to stream to LOGGING["FILE_PATH"] . |
LOGGING["FILE_PATH"] | session.log | Optional. Only use this configuration when LOGGING["TYPE"] is set to FILE . The file path to save logs of session managements. |
Django-Dysession support three kinds of logging.
Colorful TTY-based Console Log
Support colorful and beautiful log when django-dysession interacting with AWS Dysession.
Default logging stream
Django-Dysession use python core library logging.StreamHandler
Default File Stream
Django-Dysession use python core library logging.FileHandler