Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/timepoint-ai/timepoint-clockchain/llms.txt

Use this file to discover all available pages before exploring further.

Timepoint Clockchain requires Python 3.11 or higher and PostgreSQL 16+.

​
Prerequisites

1

Python 3.11+

Ensure you have Python 3.11 or higher installed:
python --version
2

PostgreSQL 16+

Clockchain requires a PostgreSQL database. See the Database Setup guide for installation instructions.

​
Installation Methods

# Install from source with pip
pip install -e ".[dev]"

​
Dependencies

The core dependencies installed automatically:
  • FastAPI (>=0.115.0) - Web framework
  • Uvicorn (>=0.30.0) - ASGI server
  • Pydantic (>=2.9.0) - Data validation
  • Pydantic Settings (>=2.6.0) - Configuration management
  • httpx (>=0.28.0) - HTTP client for Flash integration
  • asyncpg (>=0.29.0) - PostgreSQL driver
  • timepoint-tdf - TDF format support (from GitHub)

​
Development Dependencies

For testing and development: 
pip install -e ".[dev]"
This includes:
  • pytest
  • pytest-asyncio
  • httpx (for testing)

​
Verify Installation

Confirm the installation by checking the package: 
python -c "import app.main; print('Clockchain installed successfully')"

​
Next Steps

Database Setup

Configure PostgreSQL and initialize the schema

Environment Configuration

Set required environment variables

Build docs developers (and LLMs) love

Get started for freeTalk to us