Python Console App Quickstart

The Python SDK is currently in Public Preview. If you encounter any issues or need assistance, please contact Ditto Support.

Prerequisites

Ditto’s Python Quickstart supports Linux and macOS only. Before getting started, ensure you have the following:

Git installed on your machine
Python 3.10 or later installed on your machine (3.10–3.13 are supported)
A Ditto Portal account with a configured Ditto Database

We recommend uv, which installs the Python interpreter and dependencies for you. The quickstart also runs with pip and a virtual environment.

Get Started

1. Clone the Repository

The project directory contains quickstart applications for all SDKs supported by Ditto including Python.

2. Configure Ditto

Get your connection details

In the Ditto Portal, select your database and select the Connect via SDK tab. Then copy the following values:

Database ID
Development Token
URL

URL is the Ditto Server URL the SDK uses to connect to your Ditto database.

Add Ditto Credentials

Copy the .env.sample file in the quickstart directory to .env.
cd quickstart cp .env.sample .env

Update the .env file with the Database ID, Development Token, and URL from the Ditto Portal.

DITTO_DATABASE_ID="REPLACE_ME_WITH_YOUR_DATABASE_ID"
DITTO_DEVELOPMENT_TOKEN="REPLACE_ME_WITH_YOUR_DEVELOPMENT_TOKEN"
DITTO_SERVER_URL="REPLACE_ME_WITH_YOUR_URL"

3. Run the Application

Run one of the following commands. The uv and pip commands start from the python-tui directory; run the just command from the quickstart directory.

cd python-tui
uv run --with dittolive-ditto main.py

cd python-tui
python3 -m venv .venv
source .venv/bin/activate
pip install --pre dittolive-ditto
python main.py

just python-tui

Once running, manage the task list with these commands:

Command	Description
`add <title>`	Create a task
`toggle <n>`	Toggle a task’s completed state
`edit <n> <title>`	Rename a task
`del <n>`	Delete a task
`list`	Refresh the list
`quit`	Exit

Press Enter (or type list) to refresh and pick up changes made by other peers.

4. Sync-Data Offline

Optional: Run a Local Smoke Test

To check that the SDK is installed and working without using any credentials or network access, run the quickstart’s self-test. The uv and pip commands start from the python-tui directory; run the just command from the quickstart directory.

cd python-tui
uv run --with dittolive-ditto main.py --smoke

cd python-tui
source .venv/bin/activate
python main.py --smoke

just python-tui-smoke

This checks local task changes without connecting to Ditto Server.

Next Steps

All the Ditto Quickstart apps work together! Try running a quickstart app in other languages and see them all collaborate.

Overview & Setup

SDKs

Accessing Data

Syncing Data

Authentication and Authorization

Managing the Mesh

Deploying your App

Python Console App Quickstart

Prerequisites

Get Started

1. Clone the Repository

2. Configure Ditto

Get your connection details

Add Ditto Credentials

3. Run the Application

4. Sync-Data Offline

Optional: Run a Local Smoke Test

Next Steps

Additional Resources

​Prerequisites

​Get Started

​1. Clone the Repository

​2. Configure Ditto

​Get your connection details

​Add Ditto Credentials

​3. Run the Application

​4. Sync-Data Offline

​Optional: Run a Local Smoke Test

​Next Steps

​Additional Resources

Prerequisites

Get Started

1. Clone the Repository

2. Configure Ditto

Get your connection details

Add Ditto Credentials

3. Run the Application

4. Sync-Data Offline

Optional: Run a Local Smoke Test

Next Steps

Additional Resources