update docs

Author: MacHu-GWU

AUTHORS.rst

@@ -2,6 +2,6 @@
 
 About the Author
 ------------------------------------------------------------------------------
-**Sanhe Hu** is a very active **Python Developer** Since 2010. Research area includes **Machine Learning, Big Data Infrastructure, Block Chain, Business Intelligent, AWS, Distributive System**. Love photography, outdoor, arts, game, and also the best `Python <https://www.python.org/>`_.
+**Sanhe Hu** is a very active **Python Developer and AWS veteran** Since 2010. Research area includes **Machine Learning, Big Data Infrastructure, Block Chain, Business Intelligent, AWS, Distributive System**. Love photography, outdoor, arts, game, and also the best `Python <https://www.python.org/>`_.
 
 - My Github: https://github.com/MacHu-GWU

README.rst

@@ -18,6 +18,10 @@
     :target: https://pypi.python.org/pypi/pynamodb_mate
 
 .. image:: https://img.shields.io/pypi/dm/pynamodb-mate.svg
+    :target: https://pypi.python.org/pypi/pynamodb_mate
+
+.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
+    :target: https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/release-history.rst
 
 .. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
     :target: https://github.com/MacHu-GWU/pynamodb_mate-project
@@ -53,15 +57,13 @@ Welcome to ``pynamodb_mate`` Documentation
 ==============================================================================
 📙 `Full Documentation is Here <https://pynamodb-mate.readthedocs.io/>`_
 
-.. contents::
-    :class: this-will-duplicate-information-and-it-is-still-useful-here
-    :depth: 1
-    :local:
+.. image:: https://pynamodb-mate.readthedocs.io/en/latest/_static/pynamodb_mate-logo.png
+    :target: https://pynamodb-mate.readthedocs.io/
 
 
 Overview
 ------------------------------------------------------------------------------
-``pynamodb_mate`` provides advanced best practice using DynamoDB in python. Built on top of `pynamodb <https://pynamodb.readthedocs.io/en/latest/>`_ 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`` provides advanced best practice using DynamoDB in python. Built on top of `pynamodb <https://pynamodb.readthedocs.io/en/latest/>`_ 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
@@ -71,21 +73,15 @@ Even though the author is a Dynamodb Subject Matter Expert from AWS, but this pr
 
 Features
 ------------------------------------------------------------------------------
-Click on the link below to see detailed tutorial and examples.
-
-- ⭐ `Store Large Object in DynamoDB <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/Store-Large-Object-in-DynamoDB.ipynb>`_: This feature allows you to store any Python object and arbitrary big data in DynamoDB that can exceed the 400KB limit.
-- ⭐ `Client Side Encryption <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/Client-Side-Encryption.ipynb>`_: This feature allows you to use your own encryption key to encrypt your data before it is sent to the DynamoDB.
-- ⭐ `Compressed Attribute <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/Compressed-Attribute.ipynb>`_: This feature can automatically compress the data before it is sent to the DynamoDB.
-- ⭐ `AWS DynamoDB Console Url <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/AWS-DynamoDB-Console-Url.ipynb>`_: 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.
-
-
-DynamoDB Patterns
-------------------------------------------------------------------------------
-``pynamodb_mate`` also 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.
-
-- 🎉 `Cache <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/patterns/cache.ipynb>`_: This feature gives you a "Redis" liked, serverless, Zero-ops, auto-scaling, high performance, pay-as-you-go cache layer based on DynamoDB.
-- 🎉 `Status Tracker <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/patterns/status-tracker.ipynb>`_: This feature gives you the ability to track status of each task, and error-handling, retry, concurrency control out-of-the-box.
-- 🎉 `Relationship <https://github.com/MacHu-GWU/pynamodb_mate-project/blob/master/examples/patterns/relationship.ipynb>`_: 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.
+``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 <https://pynamodb-mate.readthedocs.io/en/latest/01-Store-Large-Object-in-DynamoDB/index.html>`_: 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 <https://pynamodb-mate.readthedocs.io/en/latest/02-Client-Side-Encryption/index.html>`_: This feature allows you to use your own encryption key to encrypt your data before it is sent to the DynamoDB.
+- ⭐ `Compressed Attribute <https://pynamodb-mate.readthedocs.io/en/latest/03-Compressed-Attribute/index.html>`_: 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 <https://pynamodb-mate.readthedocs.io/en/latest/04-DynamoDB-Consule-Url/index.html>`_: 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 <https://pynamodb-mate.readthedocs.io/en/latest/05-Use-DynamoDB-as-Cache-Backend/index.html>`_: 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 <https://pynamodb-mate.readthedocs.io/en/latest/06-Status-Tracker/index.html>`_: 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 <https://pynamodb-mate.readthedocs.io/en/latest/07-Modeling-Relational-Data-in-DynamoDB/index.html>`_: 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:

docs/source/03-Compressed-Attribute/index.ipynb

@@ -14,7 +14,7 @@
    "source": [
     "# Compressed Attribute\n",
     "\n",
-    "## Summary\n",
+    "## Overview\n",
     "\n",
     "Sometimes you want to compress the data before store to save DB space. For example, in an E-commerce data model, an order has many items like this: ``[{\"item_name\": \"apple\", \"item_count\": 12}, {\"item_name\": \"banana\", \"item_count\": 5}]``. There are lots of repeated information such as the keys ``\"item_name\"`` and ``\"item_count\"``.\n",
     "\n",

docs/source/06-Status-Tracker/index.ipynb

@@ -43,7 +43,7 @@
     }
    },
    "source": [
-    "# Declare Your DynamoDB Status Tracking Table\n",
+    "## Declare Your DynamoDB Status Tracking Table\n",
     "\n",
     "1. First, We define some status code using the enum Python standard library. It improves the code readability and avoids hard coding meaningless integers everywhere in the code base.\n",
     "2. We declare a DynamoDB table data model and the status GSI index schema.\n",
@@ -193,7 +193,7 @@
     }
    },
    "source": [
-    "# Initialize a Task\n",
+    "## Initialize a Task\n",
     "\n",
     "The ``Tracker.new(task_id, data)`` method can be used to initialize a task and save to DynamoDB using the ``DEFAULT_STATUS``."
    ]
@@ -402,7 +402,7 @@
     }
    },
    "source": [
-    "# Error Handling\n",
+    "## Error Handling\n",
     "\n",
     "Let's reset the task and do it one more time, this time the job logic will fail.\n",
     "\n",
@@ -592,7 +592,7 @@
     }
    },
    "source": [
-    "# Ignore Task if Failed Too Many Times\n",
+    "## Ignore Task if Failed Too Many Times\n",
     "\n",
     "You don't want a task that logically can never succeed to fail into a endless loop. In this example, we defined the max retry times is 3. If it failed 3 times in a row, it will be ignored. And if you want to start a task that is ignored, you will see an ``TaskIgnoredError``"
    ]
@@ -1079,7 +1079,7 @@
     }
    },
    "source": [
-    "# Save Custom Metadata to the Tracker\n",
+    "## Save Custom Metadata to the Tracker\n",
     "\n",
     "You may want to store custom metadata to DynamoDB. Since DynamoDB is schemaless, you can store arbitrary data in DynamoDB."
    ]
@@ -1173,7 +1173,7 @@
     }
    },
    "source": [
-    "# Query Tasks by Status\n",
+    "## Query Tasks by Status\n",
     "\n",
     "To restart some tasks from the last failed, you need to be able to query the tasks by status. The ``Tracker.query_by_status()`` method allow you to get tasks by one or many status codes. By default, it returns tasks ordered by ``update_time``."
    ]
@@ -1480,7 +1480,7 @@
     }
    },
    "source": [
-    "# Conclusion\n",
+    "## Conclusion\n",
     "\n",
     "In general, this solution can improve the visibility, resilience and reliability of a business critical application. There’s no upfront effort to use this solution, because DynamoDB is a fully managed service. Naturally, it is scalable to adapt to very high workload or unpredictable workload.\n",
     "\n",

docs/source/07-Modeling-Relational-Data-in-DynamoDB/index.ipynb

@@ -61,7 +61,7 @@
     }
    },
    "source": [
-    "# Declare Entity Table and Lookup Index"
+    "## Declare Entity Table and Lookup Index"
    ]
   },
   {
@@ -113,7 +113,7 @@
     }
    },
    "source": [
-    "# Declare Data Model for Each Entity\n",
+    "## Declare Data Model for Each Entity\n",
     "\n",
     "In this ultimate data modeling strategy, all entities are stored within a single table. To enhance code organization, readability, and maintainability, it is highly recommended to define subclasses for each entity type. By creating separate subclasses, you can encapsulate entity-specific logic, attributes, and behavior within their respective classes.\n",
     "\n",
@@ -186,7 +186,7 @@
     }
    },
    "source": [
-    "# Declare Data Model for Each Relationship\n",
+    "## Declare Data Model for Each Relationship\n",
     "\n",
     "Similarly, a relationship is just a DynamoDB item. You also need a class for each relationship."
    ]
@@ -299,7 +299,7 @@
     }
    },
    "source": [
-    "# Declare Type Hint and Iterator Proxy Object\n",
+    "## Declare Type Hint and Iterator Proxy Object\n",
     "\n",
     "This is recommended but optional."
    ]
@@ -403,7 +403,7 @@
     }
    },
    "source": [
-    "# Declare Relationship Settings\n",
+    "## Declare Relationship Settings\n",
     "\n",
     "The ``RelationshipSetting`` object is a central component of the library that stores all the metadata related to entity relationships. It serves as a configuration object that defines the characteristics and behavior of entities and their relationships.\n",
     "\n",
@@ -837,7 +837,7 @@
     }
    },
    "source": [
-    "# Setup Local DynamoDB Mock   "
+    "## Setup Local DynamoDB Mock   "
    ]
   },
   {
@@ -874,7 +874,7 @@
     }
    },
    "source": [
-    "# Create Some Test Data"
+    "## Create Some Test Data"
    ]
   },
   {
@@ -982,7 +982,7 @@
     }
    },
    "source": [
-    "# Declare Some Helper Functions For Testing"
+    "## Declare Some Helper Functions For Testing"
    ]
   },
   {
@@ -1108,7 +1108,7 @@
     }
    },
    "source": [
-    "# Test Video Ownership Relationship (One to Many)"
+    "## Test Video Ownership Relationship (One to Many)"
    ]
   },
   {
@@ -1181,7 +1181,7 @@
     }
    },
    "source": [
-    "# Test Channel Ownership Relationship (One to Many)"
+    "## Test Channel Ownership Relationship (One to Many)"
    ]
   },
   {
@@ -1285,7 +1285,7 @@
     }
    },
    "source": [
-    "# Test Channel and Video Relationship (Many to Many)"
+    "## Test Channel and Video Relationship (Many to Many)"
    ]
   },
   {
@@ -1483,7 +1483,7 @@
     }
    },
    "source": [
-    "# Test Playlist and Video Relationship (Many to Many)"
+    "## Test Playlist and Video Relationship (Many to Many)"
    ]
   },
   {
@@ -1681,7 +1681,7 @@
     }
    },
    "source": [
-    "# Test Youtuber Subscription Relationship (Many to Many)"
+    "## Test Youtuber Subscription Relationship (Many to Many)"
    ]
   },
   {
@@ -1937,7 +1937,7 @@
     }
    },
    "source": [
-    "# Test Channel Subscription Relationship (Many to Many)"
+    "## Test Channel Subscription Relationship (Many to Many)"
    ]
   },
   {

scripts/run_test_on_many_pynamodb_versions.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+Manually run unit test on different combination of pynamodb versions.
+"""
+
+import subprocess
+from pynamodb_mate.paths import dir_project_root, dir_venv_bin
+
+pynamodb_versions = [
+    "5.5.1",
+]
+path_venv_pip = dir_venv_bin / "pip"
+with dir_project_root.cwd():
+    for version in pynamodb_versions:
+        subprocess.run(
+            [
+                f"{path_venv_pip}",
+                "install",
+                f"pynamodb=={version}",
+            ]
+        )
+        subprocess.run(["pyops", "cov-only"])