Droq Node Template

A Python template for building Droqflow nodes.

Quick Start

git clone [email protected]:droq-ai/dfx-base-node-template-py.git
cd dfx-base-node-template-py
uv sync

# Replace src/node/main.py with your code
# Add dependencies: uv add your-package

# Configure node.json with your node information
# Configure environment variables

# Test locally
PYTHONPATH=src uv run python -m node.main

# Run with Docker
docker compose up

Next Steps

1. Complete your node development
2. Configure node.json with your node metadata
3. Register your node [TBD]

Docker

# Build
docker build -t your-node:latest .

# Run
docker run -p 8000:8000 \
  -e NODE_NAME=my-node \
  -e NATS_URL=nats://localhost:4222 \
  your-node:latest

Development

# Run tests
PYTHONPATH=src uv run pytest

# Format code
uv run black src/ tests/
uv run ruff check src/ tests/

# Add dependencies
uv add package-name

Documentation

• Usage Guide
• Configuration Guide
• NATS Examples

License

Apache License 2.0