A better persistence layer for python
Project description
Persisty - a better persistence Layer for Python
The objective of this project is to provide a resource oriented approach accommodating both security and caching rich enough to handle most use cases while still being independant of the underlying persistence mechanism.
Using Servey to provide access via REST and GraphQL in either a hosted environment or AWS lambda environemnt, the project includes out of the box support for both SQL (via SQLAlchemy) and Dynamodb.
Concepts
Stored Items
Stored items are marked by the stored decorator. This decorator is similar to dataclass, and allows specifying attributes, keys, schemas, and indexes.
Stores
A Store provides a unified interface for interacting with stored items. StoreMeta contains info on what exactly a store supports
Standard Actions are:
- create an item
- read and item given its key
- update an item
- delete and item given its key
- search for items given filter and sort criteria
- count items given filter criteria
- read_batch read a batch of items given a list of keys
- edit_batch execute a batch of edits (create, update, delete operations)
Keys
Each item within a store has a string key, derived from the item. (Possibly based on one or more of it's attributes) A KeyConfig controls this process
Attributes
Stored items have Attributes associated with them, similar to columns in a relational database. Attributes can have generators associated with them.
SearchFilters
Search operations can have SearchFilters These can be natively supported (Converted to SQL or dynamodb query / scan criteria) or run locally in python.
Extras
We have optional extra projects to accommodate certain common usage patterns
Persisty Data
A binary data plugin for persisty, accommondating file uploads and downloads. (Delegating to services like S3)
Persisty Dynamic
A dynamic data plugin for persisty, accommodating the case where users can define metadata on the fly, and upload data that conforms to it.
Examples
TODO:
Migrations - need a way of building out serverless resources. Build an AutoUI project in NPM
Extras
Move Triggers to extras. Dynamic storage File storage Consider building a user app Consider building a rate limiting app (Rate Limit access control)
Outside the scope of this project: Repo Synchronization
2 modes:
sqlalchemy integration Revisit the filtered_storage class - make sure reads are not done unless required, and that they are definitely not repeated change authorization permissions to scopes make authorization jwt encodable / decodable
Demos...
Actions & Triggers. Not part of core! Recipes / Goodies Also timestamping built using this
Triggers action_name may correspond to lambda name in aws trigger_type: before_create|after_create|...update|delete|web|timer
Action name: str param_schema return_schema access_control: is_executable(authorization)
Can also be periodic:
Add redis support
Add remote http support
Rate Limiting - Not Part of Core! But useful.
Demo a distributed lock.
Demo a custom index.
Deploying new versions of this Servey to Pypi
pip install setuptools wheel
python setup.py sdist bdist_wheel
pip install twine
python -m twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.