ramiro is a dockerized server for marimo notebooks based on FastAPI. The images are available under packages. Pull the latest image via docker command docker pull ghcr.io/joheli/ramiro:latest.

Spin up a docker container using the image provided with a volume (folder) containing your marimo notebooks and you should be good to go. Please note that the volume should be mapped to /app/notebooks in the container.

E.g.

docker run --name ramiro -v /your/path/to/marimo_notebooks:/app/notebooks -p 9000:9000 ghcr.io/joheli/ramiro:latest

If you have entered this on your own computer, you should now be able to access the landing page under http://localhost:9000.

You can either rebuild the image with a fresh requirements.txt file or add packages after build into the container.

To add packages into the container proceed as follows:

# Enter the container with user "app"
docker exec -it --user app ramiro bash

# once inside the container, add package XXX by typing
pip install --user --no-cache-dir XXX

# alternatively, use convenience script "pippin"
pippin XXX

You can add route(r)s to the FastAPI container. A bit of disambiguation: a route is an API endpoint, a router specifies different routes and is of type fastapi.APIRouter. To add additional endpoint "hello", create a file called hello.py with the following contents:

from fastapi import APIRouter

router = APIRouter()

@router.get("/hello")
async def say_hello():
    return {"message": "Hello!"}

Now put file hello.py into a folder that you bind as a volume to the container by adding -v /your/router/folder:/app/routers to above "docker run" command.

The files are served with uvicorn. To reload uvicorn in the container, enter the container as above. Then, type

# long command
uvicorn main:app --reload

# alternatively, use convenience script "reload"
reload

Have fun!