Skip to main content
Documentation Status https://github.com/MacHu-GWU/pynamodb_mate-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/pynamodb_mate-project/branch/master/graph/badge.svg https://img.shields.io/pypi/v/pynamodb_mate.svg https://img.shields.io/pypi/l/pynamodb_mate.svg https://img.shields.io/pypi/pyversions/pynamodb_mate.svg https://img.shields.io/pypi/dm/pynamodb-mate.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Source_Code-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to pynamodb_mate Documentation

📙 Full Documentation is Here

https://pynamodb-mate.readthedocs.io/en/latest/_static/pynamodb_mate-logo.png

Overview

pynamodb_mate provides advanced best practice using DynamoDB in python. Built on top of pynamodb python library. It maintain the compatibility to major version of pynamodb library. For example pynamodb_mate>=5.0.0,<6.0.0 is compatible to pynamodb>=5.0.0,<6.0.0, pynamodb_mate==5.5.1.X is compatible to pynamodb>=5.5.1,<6.0.0, pynamodb_mate==6.0.0.X is compatible to pynamodb>=6.0.0,<7.0.0.

Disclaimer

Even though the author is a Dynamodb Subject Matter Expert from AWS, but this project is NOT an AWS official project, and it is a personal open source project for the Python community.

Features

pynamodb_mate provides some commonly used patterns. It is based on the author’s experience providing solutions to many customers from different industries. Click on the link below to see detailed tutorial and examples.

  • ⭐ Store Large Object in DynamoDB: This feature allows you to store any Python object and arbitrary big data in DynamoDB that can exceed the 400KB limit. It also handles data consistency and data integrity between DynamoDB and S3.

  • ⭐ Client Side Encryption: This feature allows you to use your own encryption key to encrypt your data before it is sent to the DynamoDB.

  • ⭐ Compressed Attribute: This feature can automatically compress the data before it is sent to the DynamoDB, it would save you a lot of money if you use JSON attribute in DynamoDB.

  • ⭐ AWS DynamoDB Console Url: This feature can print the AWS DynamoDB console url for the table, items. You can use this in you log to quickly jump to the console to debug.

  • ⭐ Use DynamoDB as a Cache Backend: This feature gives you a “Redis” liked, serverless, Zero-ops, auto-scaling, high performance, pay-as-you-go cache layer based on DynamoDB.

  • ⭐ Enable status tracking for business critical application using Amazon DynamoDB: This feature gives you the ability to track status of each task, and error-handling, retry, concurrency control out-of-the-box.

  • ⭐ Modeling Relational Data in DynamoDB: This feature allow you to manage mass amount entity and one-to-many, many-to-many relationship in DynamoDB using the ultimate data modeling strategy that has high performance and scales well. Made data modeling in DynamoDB deadly simple.

Install

pynamodb_mate is released on PyPI, so all you need is:

$ pip install pynamodb_mate

To upgrade to latest version:

$ pip install --upgrade pynamodb_mate

In order to use the following feature, you need to run pip install pynamodb_mate[encrypt] first:

  • pynamodb_mate.EncryptedNumberAttribute

  • pynamodb_mate.EncryptedUnicodeAttribute

  • pynamodb_mate.EncryptedBinaryAttribute

  • pynamodb_mate.EncryptedJsonDictAttribute

Metadata

Release files for pynamodb-mate 6.0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pynamodb-mate 6.0.1.1
File Size Uploaded
pynamodb_mate-6.0.1.1.tar.gz 58.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pynamodb-mate 6.0.1.1
File Interpreter ABI Platform
pynamodb_mate-6.0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 129.9 kB

Release files / pynamodb_mate-6.0.1.1.tar.gz

Download URL pynamodb_mate-6.0.1.1.tar.gz
Size 58.2 kB
Tags Source
SHA-256 checksum
How to use checksums
23b5c2000c0dd11bf4e6860871ff6b68691333867c70c3a151e863a0bd5051e1
BLAKE2b-256 checksum
How to use checksums
b9667584b134de68b382a75595da5672a6468991ac47b31134b81eaafd1b3e28
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.8.13

Release files / pynamodb_mate-6.0.1.1-py3-none-any.whl

Download URL pynamodb_mate-6.0.1.1-py3-none-any.whl
Size 71.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8cd7eeb72aaf5ba765b7f3275a86b058b0d41c8c814dbd2a90efc5f6ada6752d
BLAKE2b-256 checksum
How to use checksums
ee751a1212427d6e8f4bb524e131f061a3dadcb9869d1a27d1545957ec032e36
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.8.13
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page