statikk 0.0.13__tar.gz → 0.1.0__tar.gz

{statikk-0.0.13 → statikk-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: statikk
-Version: 0.0.13
+Version: 0.1.0
 Summary: statikk is a single table application (STA) library for DynamoDb.
 Home-page: https://github.com/terinia/statikk
 Author: Balint Biro
@@ -27,11 +27,9 @@ Requires-Dist: moto[dynamodb]==4.2.14; extra == "testing"
     :alt: Statikk
     :align: center
 
-We built this library because we got fed up with all the boilerplate we needed to write to use DynamoDB in a Single Table Application architecture.
-We were originally using `PynamoDB <https://github.com/pynamodb/PynamoDB>`_ , but we found it to be too verbose for our liking.
+An ORM-like Single Table Application (STA) architecture library for Python and DynamoDb. Makes it really eason to set up and work with STAs.
 
-This library is very much in alpha phase and is not yet recommended for production use. We are actively working on it and using it as a core library
-for our upcoming game, Conquests of Ethoas. Drastic API changes can still happen.
+The library is in alpha. Constant work is being done on it as I'm developing my game.
 
 =================
 Requirements
@@ -55,15 +53,19 @@ Basic Usage
 
 .. code-block:: python
 
-    from statikk.models import DatabaseModel, Table, GlobalSecondaryIndex, KeySchema, IndexPrimaryKeyField, IndexSecondaryKeyField
+    from statikk.models import DatabaseModel, Table, GlobalSecondaryIndex, KeySchema
 
     class MyAwesomeModel(DatabaseModel):
-      player_id: IndexPrimaryKeyField
-      tier: IndexSecondaryKeyField
+      player_id: str
+      tier: str
       name: str = "Foo"
       values: set = {1, 2, 3, 4}
       cost: int = 4
 
+      @classmethod
+      def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+        return {"main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["tier"])}
+
     table = Table(
       name="my-dynamodb-table",
       key_schema=KeySchema(hash_key="id"),

{statikk-0.0.13 → statikk-0.1.0}/README.rst

@@ -2,11 +2,9 @@
     :alt: Statikk
     :align: center
 
-We built this library because we got fed up with all the boilerplate we needed to write to use DynamoDB in a Single Table Application architecture.
-We were originally using `PynamoDB <https://github.com/pynamodb/PynamoDB>`_ , but we found it to be too verbose for our liking.
+An ORM-like Single Table Application (STA) architecture library for Python and DynamoDb. Makes it really eason to set up and work with STAs.
 
-This library is very much in alpha phase and is not yet recommended for production use. We are actively working on it and using it as a core library
-for our upcoming game, Conquests of Ethoas. Drastic API changes can still happen.
+The library is in alpha. Constant work is being done on it as I'm developing my game.
 
 =================
 Requirements
@@ -30,15 +28,19 @@ Basic Usage
 
 .. code-block:: python
 
-    from statikk.models import DatabaseModel, Table, GlobalSecondaryIndex, KeySchema, IndexPrimaryKeyField, IndexSecondaryKeyField
+    from statikk.models import DatabaseModel, Table, GlobalSecondaryIndex, KeySchema
 
     class MyAwesomeModel(DatabaseModel):
-      player_id: IndexPrimaryKeyField
-      tier: IndexSecondaryKeyField
+      player_id: str
+      tier: str
       name: str = "Foo"
       values: set = {1, 2, 3, 4}
       cost: int = 4
 
+      @classmethod
+      def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+        return {"main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["tier"])}
+
     table = Table(
       name="my-dynamodb-table",
       key_schema=KeySchema(hash_key="id"),
@@ -71,4 +73,4 @@ Features
 - `Single Table Application architecture <https://www.youtube.com/watch?v=HaEPXoXVf2k>`_
 - Easy model definition using Pydantic
 - Automatic index value construction based on marked fields.
-- Get, Update, Delete, Batch Get, Batch Write, Query, and Scan operations
+- Get, Update, Delete, Batch Get, Batch Write, Query, and Scan operations

{statikk-0.0.13 → statikk-0.1.0}/docs/usage.rst

@@ -50,21 +50,14 @@ Model definition
 
   class Player(DatabaseModel):
     # we don't define an id field, so a uuid will be automatically assigned to the model when it's created
-    last_login_date: IndexSecondaryKeyField
+    last_login_date: datetime
 
     @classmethod
-    def type_is_primary_key(cls):
-        # Makes the model's type the primary key. The model's type is the class name
-        return True
+    def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+        return {"main-index": IndexFieldConfig(pk_fields=["type"], sk_fields=["last_login_date"])}
 
     @classmethod
-    def include_type_in_sort_key(cls):
-        # By default, the model's type is alawys included in the sort key. This is useful to avoid collisions of similar
-        # models that share the same primary key. Here however, we want the type to be the primary key only.
-        return False
-
-    @classmethod
-    def model_type(cls):
+    def type(cls):
       # The default return value for this method is the name of the class, but feel free to override it here to whatever
       # you'd like present in the sort key.
       return "Player"
@@ -72,11 +65,15 @@ Model definition
 
   class Card(DatabaseModel):
     id: str
-    player_id: IndexPrimaryKeyField
-    tier: IndexSecondaryKeyField
+    player_id: str
+    tier: str
     values: list[int]
     cost: int
 
+    @classmethod
+    def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+      return {"main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["tier"])}
+
 The above setup allows us to query the table in the following ways:
  - Get all players
  - Get all players by their last login date
@@ -168,9 +165,13 @@ Let's take a look at an example:
 
     class MultiKeyCard(DatabaseModel):
       id: str
-      player_id: IndexPrimaryKeyField
-      origin: IndexSecondaryKeyField
-      tier: IndexSecondaryKeyField
+      player_id: str
+      origin: str
+      tier: str
+
+      @classmethod
+      def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+        return {"main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["origin", "tier"])}
 
 This setup allows you to search using the following patterns:
  - Get all cards belonging to a player
@@ -180,15 +181,6 @@ This setup allows you to search using the following patterns:
 Note that the order is **REALLY** important here. Swapping up the order in on your production data will cause absolute havoc on your queries
 and will taint your data.
 
-It is **HIGHLY RECOMMENDED** to manually define the order property on your secondary index fields.
-
-.. code-block:: python
-
-    class MultiKeyCard(DatabaseModel):
-      id: str
-      player_id: IndexPrimaryKeyField
-      origin: IndexSecondaryKeyField(order=1)
-      tier: IndexSecondaryKeyField(order=2)
 
 ====================
 Multiple indexes
@@ -199,10 +191,17 @@ Statikk also supports multiple indexes. This is useful if you want to query your
 .. code-block:: python
 
   class MultiIndexModel(DatabaseModel):
-    player_id: IndexPrimaryKeyField
-    tier: IndexSecondaryKeyField
-    origin: IndexPrimaryKeyField = IndexPrimaryKeyField(index_names=["secondary-index"])
-    unit_class: IndexSecondaryKeyField = IndexSecondaryKeyField(index_names=["main-index", "secondary-index"])
+    player_id: str
+    tier: str
+    origin: str
+    unit_class: str
+
+    @classmethod
+    def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+      return {
+        "main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["tier", "unit_class"]),
+        "secondary-index": IndexFieldConfig(pk_fields=["origin"], sk_fields=["unit_class"]),
+      }
 
 This setup requires the table to have two indexes defined: main-index and secondary index. Notice that the ``unit_class`` field
 is actually part of both the main and the secondary index. So when Statikk constructs the index values for this model, it will include
@@ -231,8 +230,12 @@ For example:
 .. code-block:: python
 
     class Card(DatabaseModel):
-        player_id: IndexPrimaryKeyField
-        cost: IndexSecondaryKeyField(type=int)
+        player_id: str
+        cost: int
+
+    @classmethod
+    def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+      return {"main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["cost"])}
 
     def query_data():
        models = list(Card.query(hash_key=Equals(player.id), range_key=GreaterThan(4), filter_condition=Attr("type").gte("Card")))
@@ -287,12 +290,16 @@ Let's take a look at an example:
 .. code-block:: python
 
   class Card(DatabaseModel):
-    player_id: IndexPrimaryKeyField
-    tier: IndexSecondaryKeyField
+    player_id: str
+    tier: str
     values: set[int]
     cost: int
     name: str = "Foo"
 
+    @classmethod
+    def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+      return {"main-index": IndexFieldConfig(pk_fields=["player_id"], sk_fields=["tier"])}
+
   card = Card(player_id=player.id, tier="EPIC", values={1, 2, 3, 4}, cost=5, name="FooFoo")
   card.save()
   card.update().set("tier", "LEGENDARY").delete("values", {1}).add("cost", 4).remove("name").execute()

{statikk-0.0.13 → statikk-0.1.0}/setup.py

@@ -1,11 +1,12 @@
 """
-    Setup file for statikk.
-    Use setup.cfg to configure your project.
+Setup file for statikk.
+Use setup.cfg to configure your project.
 
-    This file was generated with PyScaffold 4.5.
-    PyScaffold helps you to put up the scaffold of your new Python project.
-    Learn more under: https://pyscaffold.org/
+This file was generated with PyScaffold 4.5.
+PyScaffold helps you to put up the scaffold of your new Python project.
+Learn more under: https://pyscaffold.org/
 """
+
 from setuptools import setup
 
 if __name__ == "__main__":

{statikk-0.0.13 → statikk-0.1.0}/src/statikk/conditions.py

@@ -10,6 +10,7 @@ Example usage of this module:
     from statikk.conditions import Equals, BeginsWith
     app.query(range_key=Equals("123"), hash_key=BeginsWith("abc"))
 """
+
 from abc import ABC, abstractmethod
 from boto3.dynamodb.conditions import Key, ComparisonCondition
 from typing import Any
@@ -37,8 +38,8 @@ class BeginsWith(Condition):
         return Key(key).begins_with(self.value)
 
     def enrich(self, model_class, **kwargs):
-        if not self.value.startswith(model_class.model_type()) and model_class.include_type_in_sort_key():
-            self.value = f"{model_class.model_type()}|{self.value}"
+        if not self.value.startswith(model_class.type()):
+            self.value = f"{model_class.type()}|{self.value}"
 
 
 class LessThan(Condition):