Skip to main content

Server side sessions in Flask using AWS DynamoDB table as a data store

Project description

# Flask DynamoDB Sessions

[![](https://img.shields.io/pypi/v/flask-dynamodb-sessions.svg)](https://pypi.org/project/flask-dynamodb-sessions/) [![Updates](https://pyup.io/repos/github/ibejohn818/flask-dynamodb-sessions/shield.svg)](https://pyup.io/repos/github/ibejohn818/flask-dynamodb-sessions/)

Server-side sessions in Flask using AWS DynamoDB as the backend data store.

DynamoDB is AWS's SaaS NoSQL solution which makes it perfect for use as a session store.
Being a SaaS service we no longer have to manage servers/storage/etc and take advantage of some notable features such as:

- Auto-scaling
- Automatic Lifecycle ( Garbage collection )
- Encryption at rest
- etc...

## Installation

```shell
# w/ pip
pip install flask-dynamodb-sessions
# w/ easy_install
easy_install flask-dynamodb-sessions
```

### Usage example
```python
from flask import (Flask, session)
from flask_dynamodb_sessions import Session

app = Flask(__name__)

# Set flask to use the dynamo session interface
Session(app)

@app.route('/', methods=['GET'])
def index_get():
# use sessions just as you normally would
session['user'] = {'username': 'jhardy'}

user = session.get('user')

session_id = session.sid
```
*View examples directory for more*

The session dictionary is serialized using `json.dumps({SESSION}, default=str)`. More advanced serialization is in-progress.

### Configuration Options
Below are additional `SESSION_*` configuration options specific to DynamoDB sessions.

SESSION_DYNAMODB_TABLE (string): The DynamoDB table to save to. Default: flask_sessions
SESSION_DYNAMODB_ENDPOINT (string): Override the boto3 endpoint, good for local development and using dynamodb-local. Default: None
SESSION_DYNAMODB_TTL_SECONDS (int): Number of seconds to add to the TTL column. Default: 86400 * 14 (14 Days)

The existing `SESSION_*` config parameters still apply (IE: cookie settings). SESSION_REFRESH_EACH_REQUEST is the only setting that is negated and each request will refesh the cookie (Might be modified in a future release).

### Table Structure
The table structure is faily simple.
```
{
id: string HASH,
modified: string DATETIME UTC
ttl: number UTC TIME + SESSION_DYANMODB_TTL_SECONDS
data: string JSON ENCODED SESSION

}
```
You can find table creation scripts in the `utils/dynamo` directory.

The `ttl` column is present to take advantage of DynamoDB's `Lifecycle` feature where dynamo will delete all rows with a ttl in the past.


## TODO
- Advanced serialization of session (IE: Pickling )
- Test coverage
- More laxed cookie refresh


=======
History
=======

0.1.0 (2019-01-04)
------------------

* First release on PyPI.


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

flask-dynamodb-sessions-0.1.2.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

flask_dynamodb_sessions-0.1.2-py2.py3-none-any.whl (5.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flask-dynamodb-sessions-0.1.2.tar.gz.

File metadata

  • Download URL: flask-dynamodb-sessions-0.1.2.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

File hashes

Hashes for flask-dynamodb-sessions-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7cb4242fc03457c0ccf7f574d6541a4809032d44c31dfb2a3c59e929e2f50291
MD5 b604d91b91604419e32daf892edeb62a
BLAKE2b-256 3f94cf8256b526ba614242e274e73a9357fe01faf1bbc9920d92843b5239790a

See more details on using hashes here.

File details

Details for the file flask_dynamodb_sessions-0.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: flask_dynamodb_sessions-0.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

File hashes

Hashes for flask_dynamodb_sessions-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b933dc59c6e08f0f6923585e4a871248a9e03e5369f9b6ed154cb1ba04211038
MD5 9faaabbdeda39a41b5ec6dc4d90ee082
BLAKE2b-256 0f9b118f6d567dbd0bf46b3928e870825fa66150fcd0046318deb3cf0125e542

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page