RC with make_index_query

.github/workflows/main.yml

@@ -31,4 +31,3 @@ jobs:
             python3 setup.py sdist bdist_wheel
             python3 -m twine check dist/*
             python3 -m twine upload --skip-existing dist/* --verbose -u ${USERNAME} -p ${PASSWORD}
-

Makefile

@@ -1,7 +1,3 @@
-PROJECT_NAME = pynamodb-utils
-LAMBDA_PYTHON_PACKAGE_NAME = $(PROJECT_NAME)
-COV = pynamodb_utils
-
-include build/makefile/root.mk
-include build/makefile/python.mk
-include build/makefile/lint.mk
+include makefiles/root.mk
+include makefiles/python.mk
+include makefiles/lint.mk

README.md

@@ -24,10 +24,25 @@ from pynamodb_utils import DynamicMapAttribute, AsDictModel,
 JSONQueryModel, TimestampedModel
 
 
+class CategoryEnum(enum.Enum):
+    finance = enum.auto()
+    politics = enum.auto()
+
+class PostCategoryCreatedAtGSI(GlobalSecondaryIndex):
+    category = EnumAttribute(hash_key=True, enum=CategoryEnum)
+    created_at = UTCDateTimeAttribute(range_key=True)
+
+    class Meta:
+        index_name = "example-index-name"
+        projection = AllProjection
+
 class Post(AsDictModel, JSONQueryModel, TimestampedModel):
     name = UnicodeAttribute(hash_key=True)
+    sub_name = UnicodeAttribute(range_key=True)
+    category = EnumAttribute(enum=CategoryEnum, default=CategoryEnum.finance)
     content = UnicodeAttribute()
     tags = DynamicMapAttribute(default={})
+    category_created_at_gsi = PostCategoryCreatedAtGSI()
 
     class Meta:
         table_name = 'example-table-name'
@@ -37,20 +52,24 @@ Post.create_table(read_capacity_units=10, write_capacity_units=10)
 
 post = Post(
     name='A weekly news.',
+    sub_name='Shocking revelations',
     content='Last week took place...',
+    category=CategoryEnum.finance,
     tags={
         "type": "news",
         "topics": ["stock exchange", "NYSE"]
     }
 )
 post.save()
 
-condition = Post.get_conditions_from_json(query={
-    "created_at__lte": str(datetime.now()),
-    "tags.type__equals": "news",
-    "tags.topics__contains": ["NYSE"]
-})
-results = Post.scan(filter_condition=condition)
+condition = Post.make_index_query(
+    query={
+        "created_at__lte": str(datetime.now()),
+        "sub_name__exists": None,
+        "category__equals": "finance",
+        "OR": {"tags.type__equals": "news", "tags.topics__contains": ["NYSE"]},
+    }
+) # class method executes query on the most optimal index
 print(next(results).as_dict())
 ```
 That lines of code should result with following output
@@ -71,4 +90,4 @@ That lines of code should result with following output
 
 ## Links
 * https://github.com/pynamodb/PynamoDB
-* https://pypi.org/project/pynamodb-utils/
+* https://pypi.org/project/pynamodb-utils/