ezcosmos 0.1.0

A small convenience wrapper for Azure Cosmos DB CRUD operations.

ezcosmos

A small convenience wrapper for Azure Cosmos DB CRUD operations.

Installation

pip install ezcosmos

For local development from this repository:

python -m pip install -e .

Usage

Set your Cosmos DB credentials:

export COSMOS_URL="https://your-account.documents.azure.com:443/"
export COSMOS_KEY="your-cosmos-key"

Use the package:

from ezcosmos import CosmosStore

store = CosmosStore(
    database_name="prototype-db",
    container_name="documents",
    partition_key_path="/partitionKey",
)

item = store.write(
    {
        "id": "1",
        "partitionKey": "default",
        "name": "Junbum",
        "city": "Christchurch",
    }
)

print(item)

Command Line

After installing the package, use the ezcosmos command:

ezcosmos \
  --database prototype-db \
  --container documents \
  read 1

You can also pass credentials directly instead of using COSMOS_URL and COSMOS_KEY:

ezcosmos \
  --url "https://your-account.documents.azure.com:443/" \
  --key "your-cosmos-key" \
  --database prototype-db \
  --container documents \
  write '{"id": "1", "partitionKey": "default", "name": "Junbum"}'

You can also run the sample in examples/basic_usage.py:

python examples/basic_usage.py

Build

Install build tooling:

python -m pip install build twine

Build the package:

python -m build

Check the package metadata:

python -m twine check dist/*

Upload to TestPyPI:

python -m twine upload --repository testpypi dist/*

Upload to PyPI:

python -m twine upload dist/*