django-dynamodb-cache 0.2.0

No project description provided

django-dynamodb-cache

Fast, safe, cost-effective DynamoDB cache backend for Django

• django-dynamodb-cache
  • Installation
  • Setup on Django
  • Aws credentials
  • Create cache table command
  • How to contribute

Installation

pip install django-dynamodb-cache

Setup on Django

On Django settings.py

INSTALLED_APPS = [
    ...
    "django_dynamodb_cache"
]

CACHES = {
    "default": {
        "BACKEND": "django_dynamodb_cache.backend.DjangoCacheBackend",
        "LOCATION": "table-name",  # default: django-dynamodb-cache
        "TIMEOUT": 120,  # seconds
        "KEY_PREFIX": "django_dynamodb_cache",
        "VERSION": 1,
        "KEY_FUNCTION": "path.to.function",  # f"{prefix}:{key}:{version}"
        "OPTIONS": {
            "aws_region_name": "us-east-1",
            "read_capacity_units": 1,
            "write_capacity_units": 1,
            "encode": "django_dynamodb_cache.encode.PickleEncode"
        }
    }
}

Aws credentials

The same method as configuring-credentials provided in the boto3 documentation is used. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials

Create cache table command

Run manage command to create cache table on Dynamodb before using

python manage.py createcachetable

How to contribute

This project is welcome to contributions!

Please submit an issue ticket before submitting a patch.

Pull requests are merged into the main branch and should always remain available.

After passing all test code, it is reviewed and merged.