Skip to content

Local Setup & Development

A python virtual environment, with required packages installed.

Using the uv virtual environment and package manager:

# sync the requirements to a virtual environment
uv sync

If you’ve done this before, you can also use the command uv sync --upgrade to check for any package version upgrades.

Use the included dotenv.template and create a .env file with your specific environment variables.

Only one environment variable is required:

  • PROJECT_ID your Google Cloud Project ID, obtained via gcloud config get project

See the template dotenv.template file for the defaults and what environment variable options are available.

Once you have your environment variables set, either on the command line or an in .env file:

Terminal window
uv run main.py

Please see the Developer’s Guide for more information on how this application was built, including specific information about Mesop and the scaffold for Studio style apps.

When developing this app, since it’s a FastAPI application that serves Mesop, please use the following

Terminal window
uv run main.py

Traditional Mesop hot reload capabilities (i.e. mesop main.py) are not fully available at this time.