Skip to content

local-development.md

Latest commit

 

History

History
78 lines (48 loc) · 1.96 KB

local-development.md

File metadata and controls

78 lines (48 loc) · 1.96 KB

Local Development

This document describes the Docker-only local setup for mpt-api-python-client.

Read contributing.md for the repository workflow and usage.md for installation and runtime examples.

Prerequisites

  • Docker and Docker Compose plugin (docker compose CLI)
  • Make

Setup

1. Clone the repository

git clone <repository-url>
cd mpt-api-python-client

2. Create environment configuration

cp .env.sample .env

Edit .env with your actual values. See Environment Variables below.

3. Build the Docker images

make build

This builds the app image defined in compose.yaml.

4. Verify the setup

make test

Working In Docker

Use the repository make targets instead of ad hoc local Python commands. For the full command catalog, see usage.md and testing.md.

make bash      # open a shell in the app container
make run       # start an IPython session in the app container

Environment Variables

Docker Compose loads environment variables from .env.

  • Client variables are documented in usage.md.
  • E2E-specific variables are documented in e2e_tests.md.

Docker

The development environment runs entirely inside Docker:

  • Base image: ghcr.io/astral-sh/uv:python3.12-bookworm-slim
  • Package manager: uv
  • Service: app, defined in compose.yaml, with the repository mounted at /mpt_api_client

Make Targets

Run make help to see all available commands.

Shared references: