Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PynamoDB

https://img.shields.io/pypi/v/pynamodb.svg https://img.shields.io/conda/vn/conda-forge/pynamodb.svg https://github.com/pynamodb/PynamoDB/workflows/Tests/badge.svg https://img.shields.io/coveralls/pynamodb/PynamoDB/master.svg

A Pythonic interface for Amazon’s DynamoDB.

DynamoDB is a great NoSQL service provided by Amazon, but the API is verbose. PynamoDB presents you with a simple, elegant API.

Useful links:

Installation

From PyPi:

$ pip install pynamodb

From GitHub:

$ pip install git+https://github.com/pynamodb/PynamoDB#egg=pynamodb

From conda-forge:

$ conda install -c conda-forge pynamodb

Basic Usage

Create a model that describes your DynamoDB table.

from pynamodb.models import Model
from pynamodb.attributes import UnicodeAttribute

class UserModel(Model):
    """
    A DynamoDB User
    """
    class Meta:
        table_name = "dynamodb-user"
    email = UnicodeAttribute(null=True)
    first_name = UnicodeAttribute(range_key=True)
    last_name = UnicodeAttribute(hash_key=True)

PynamoDB allows you to create the table if needed (it must exist before you can use it!):

UserModel.create_table(read_capacity_units=1, write_capacity_units=1)

Create a new user:

user = UserModel("John", "Denver")
user.email = "djohn@company.org"
user.save()

Now, search your table for all users with a last name of ‘Denver’ and whose first name begins with ‘J’:

for user in UserModel.query("Denver", UserModel.first_name.startswith("J")):
    print(user.first_name)

Examples of ways to query your table with filter conditions:

for user in UserModel.query("Denver", UserModel.email=="djohn@company.org"):
    print(user.first_name)

Retrieve an existing user:

try:
    user = UserModel.get("John", "Denver")
    print(user)
except UserModel.DoesNotExist:
    print("User does not exist")

Upgrade Warning

The behavior of ‘UnicodeSetAttribute’ has changed in backwards-incompatible ways as of the 1.6.0 and 3.0.1 releases of PynamoDB.

See UnicodeSetAttribute upgrade docs for detailed instructions on how to safely perform the upgrade.

Advanced Usage

Want to use indexes? No problem:

from pynamodb.models import Model
from pynamodb.indexes import GlobalSecondaryIndex, AllProjection
from pynamodb.attributes import NumberAttribute, UnicodeAttribute

class ViewIndex(GlobalSecondaryIndex):
    class Meta:
        read_capacity_units = 2
        write_capacity_units = 1
        projection = AllProjection()
    view = NumberAttribute(default=0, hash_key=True)

class TestModel(Model):
    class Meta:
        table_name = "TestModel"
    forum = UnicodeAttribute(hash_key=True)
    thread = UnicodeAttribute(range_key=True)
    view = NumberAttribute(default=0)
    view_index = ViewIndex()

Now query the index for all items with 0 views:

for item in TestModel.view_index.query(0):
    print("Item queried from index: {0}".format(item))

It’s really that simple.

Want to use DynamoDB local? Just add a host name attribute and specify your local server.

from pynamodb.models import Model
from pynamodb.attributes import UnicodeAttribute

class UserModel(Model):
    """
    A DynamoDB User
    """
    class Meta:
        table_name = "dynamodb-user"
        host = "http://localhost:8000"
    email = UnicodeAttribute(null=True)
    first_name = UnicodeAttribute(range_key=True)
    last_name = UnicodeAttribute(hash_key=True)

Want to enable streams on a table? Just add a stream_view_type name attribute and specify the type of data you’d like to stream.

from pynamodb.models import Model
from pynamodb.attributes import UnicodeAttribute
from pynamodb.constants import STREAM_NEW_AND_OLD_IMAGE

class AnimalModel(Model):
    """
    A DynamoDB Animal
    """
    class Meta:
        table_name = "dynamodb-user"
        host = "http://localhost:8000"
        stream_view_type = STREAM_NEW_AND_OLD_IMAGE
    type = UnicodeAttribute(null=True)
    name = UnicodeAttribute(range_key=True)
    id = UnicodeAttribute(hash_key=True)

Features

  • Python >= 3.7 support

  • An ORM-like interface with query and scan filters

  • Compatible with DynamoDB Local

  • Supports the entire DynamoDB API

  • Support for Unicode, Binary, JSON, Number, Set, and UTC Datetime attributes

  • Support for Global and Local Secondary Indexes

  • Provides iterators for working with queries, scans, that are automatically paginated

  • Automatic pagination for bulk operations

  • Complex queries

  • Batch operations with automatic pagination

  • Iterators for working with Query and Scan operations

Metadata

Release files for pynamodb 6.0a0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pynamodb 6.0a0
File Size Uploaded Provenance Actions
pynamodb-6.0a0.tar.gz 94.4 kB Without provenance Details for pynamodb-6.0a0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pynamodb 6.0a0
File Interpreter ABI Platform Actions
pynamodb-6.0a0-py3-none-any.whl Python 3 none any Details for pynamodb-6.0a0-py3-none-any.whl

Total release size: 155.5 kB

Release files / pynamodb-6.0a0.tar.gz

Download URL pynamodb-6.0a0.tar.gz
Size 94.4 kB
Tags Source
SHA-256 checksum
How to use checksums
387382f3edcd49d87613818a894a0f51392ee703a5f596af10fd9942015523ce
BLAKE2b-256 checksum
How to use checksums
9ef89161f1a6c0e4658dea22b104f153a7cb83ac1db2a3948d14397d6ff5ffcd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / pynamodb-6.0a0-py3-none-any.whl

Download URL pynamodb-6.0a0-py3-none-any.whl
Size 61.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
72d2f57971e37610700856cd3db5137c053c8ff4b239b37e250e34e1964ec63a
BLAKE2b-256 checksum
How to use checksums
b5bf9f259a9a4d9b828ff3c1926cf64171a398cf4241a2195d22d228305730db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Security for pynamodb 6.0a0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page