statikk 0.0.12

statikk is a single table application (STA) library for DynamoDb.

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 , but we found it to be too verbose for our liking.

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.

Requirements

• Pydantic 2.3+

• Python 3.8+

Probably works on older versions of Python, but we haven’t tested it.

Installation

pip install statikk

Basic Usage

from statikk.models import DatabaseModel, Table, GlobalSecondaryIndex, KeySchema, IndexPrimaryKeyField, IndexSecondaryKeyField

class MyAwesomeModel(DatabaseModel):
  player_id: IndexPrimaryKeyField
  tier: IndexSecondaryKeyField
  name: str = "Foo"
  values: set = {1, 2, 3, 4}
  cost: int = 4

table = Table(
  name="my-dynamodb-table",
  key_schema=KeySchema(hash_key="id"),
  indexes=[
    GSI(
      name="main-index",
      hash_key=Key(name="gsi_pk"),
      sort_key=Key(name="gsi_sk"),
     )
   ],
  models=[MyAwesomeModel],
)

def main():
  my_model = MyAwesomeModel(id="foo", player_id="123", tier="gold")
  my_model.save()
  MyAwesomeModel.update("foo").set(name="Bar").delete("values", {1}).add("cost", 1).execute() # Update multiple fields at once
  my_model = table.get("foo", MyAwesomeModel) # Get a model by its primary key using the table
  my_model = MyAwesomeModel.get("foo") # Get a model by its primary key using the model's class
  my_model.gsi_pk # returns "123"
  my_model.gsi_sk # returns "MyAwesomeModel|gold"
  my_model.delete() # Delete a model

See the usage docs for more

Features

• Single Table Application architecture

• Easy model definition using Pydantic

• Automatic index value construction based on marked fields.

• Get, Update, Delete, Batch Get, Batch Write, Query, and Scan operations