Metadata-Version: 2.1
Name: cerami
Version: 0.2.1
Summary: A Dynamodb ORM
Home-page: https://github.com/gummybuns/cerami
Author: Zac Brown
Author-email: gummybuns@protonmail.com
License: UNKNOWN
Description: ## Quickstart
        ```
        # Setup the db singleton
        import boto3
        from cerami import Cerami
        dynamodb = boto3.client('dynamodb')
        db = Cerami(dynamodb)
        
        
        # create classes
        import uuid
        from cerami.datatype import String, Set, Datetime
        from cerami.decorators import primary_key
        
        @primary_key('_id', 'title')
        class Book(db.Model):
            __tablename__ = "Books"
        
            _id = String(default=uuid.uuid4)
            title = String()
            authors = Set(String())
            publisher = String()
            book_producer = String()
            tags = Set(String())
            published = Datetime()
            rights = String()
            identifiers = String()
            comments = String()
        
        # Query
        Book.scan\
            .filter(Book.title.eq("Zac's First Book"))\
            .filter(Book.comments.eq("Awesome"))\
            .execute()
        
        Book.query\
            .key(Book._id.eq("XXX"))\
            .filter(Book.comments.eq("YYY"))\
            .execute()
        
        Book.get\
            .key(Book.Schema._id.eq("XXX"))\
            .key(Book.Schema.title.eq("ZZZ"))\
            .execute()
        ```
        
        ## Setup Dynamodb / boto3
        You need to install the aws2 cli and have dynamo db running locally. Dynamodb requires java to run locally as well so good luck if you dont have it. Try these steps first and see how it goes.
        
        ### Download DynamoDB Locally
        1. [Download DynamoDB Locally](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.DownloadingAndRunning.html)
        1. Unzip/Untar the content
        1. Move to somewhere you wont lose it.
        
        ### Download the AWS2 CLI
        1. [Download the AWS2 CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
        1. Follow the install instructions
        
        ### Configure the AWS2 CLI
        In order to run DynamoDB locally, you need to configure the cli as such:
        
        ```
        aws2 configure
        ```
        
        ```
        AWS Access Key ID: "fakeMyKeyId"
        AWS Secret Access Key: "fakeSecretAccessKey"
        us-west-1
        ```
        
        ### Starting DynamoDB Locally
        ```
        java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
