🫧 sauber-devpi

sauber-devpi is a fully Dockerized solution for setting up and running a DevPI server. It handles multiple user and index creation, and it is designed to be easily deployed on cloud platforms like Railway.

Features

• Automated DevPI server setup
• Multiple user and index creation based on environment variables
• Fully Dockerized for easy deployment
• Multi-stage Docker build for optimized image sizes
• Helper scripts for easy interaction with the DevPI server

Project Structure

sauber-devpi/
├── src/
│   └── sauber_devpi/
│       ├── __init__.py
│       ├── main.py              # Handles DevPI server setup, user, and index creation
│       └── docker_setup.py      # Installs poetry dependencies in Docker
├── scripts/
│   ├── export_env.sh            # Exports environment variables
│   ├── devpi_kaosmaps.sh        # Helper script for interacting with the kaosmaps index
│   ├── docker_run.sh            # Script to run the Docker container
│   ├── docker_build.sh          # Script to build the Docker image
│   └── devpi_admin.sh           # Script for admin login to DevPI
├── pyproject.toml               # Poetry configuration for dependencies
├── Dockerfile                   # Docker configuration for multi-stage builds
├── .env                         # Environment variable definitions for the DevPI setup
├── .gitignore                   # Git ignore file (assumed to exist)
└── README.md                    # Project documentation

Requirements

• Docker
• Poetry (for local development)

Environment Variables

The .env file provides an easy way to configure the DevPI setup. Here are the variables that can be configured:

• DEVPI_SERVER: The URL of the DevPI server (default: http://localhost:3141).
• DEVPI_USER: The username for the admin DevPI user (default: admin).
• DEVPI_PASSWORD: The password for the admin DevPI user.
• DEVPI_KAOSMAPS_USER: The username for the kaosmaps DevPI user (default: kaosmaps).
• DEVPI_KAOSMAPS_PASSWORD: The password for the kaosmaps DevPI user.
• DEVPI_INDEX: The name of the DevPI index to be created (default: dev).

To customize these, modify the .env file before building and running the container.

Local Development

If you'd like to run the DevPI server locally without Docker, follow these steps:

1. Clone the repository: git clone cd sauber-devpi

2. Install dependencies with poetry: poetry install

3. Run the DevPI server: poetry run python -m sauber_devpi.main

Docker Instructions

Build the Docker Image

To build the Docker image, run the following command in the root directory:

docker build -t sauber-devpi .

Run the Docker Container

Once the image is built, you can run the container using the following command:

./scripts/docker_run.sh

This script will:

• Load the environment variables from the .env file.
• Run the Docker container, exposing port 3141 on the host machine.

Helper Scripts

export_env.sh

This script exports the environment variables defined in the .env file. It's used by other scripts to ensure they have access to the correct configuration.

Usage:

source ./scripts/export_env.sh

docker_build.sh

This script builds the Docker image for the sauber-devpi project.

Usage:

./scripts/docker_build.sh

docker_run.sh

This script runs the Docker container, loading environment variables from the .env file and exposing port 3142.

Usage:

./scripts/docker_run.sh

devpi_railway_admin.sh

This script logs in to the DevPI server as the admin user, creates the admin index if it doesn't exist, and optionally uploads packages.

Usage:

./scripts/devpi_railway_admin.sh

devpi_railway_kaosmaps.sh

This script helps interact with the kaosmaps index on the Railway-deployed server. It:

• Logs in to the kaosmaps user
• Creates the kaosmaps index if it doesn't exist
• Optionally uploads packages to the index if a pyproject.toml file is present

Usage:

./scripts/devpi_railway_kaosmaps.sh

devpi_local_admin.sh

This script logs in to the local DevPI server as the admin user.

Usage:

./scripts/devpi_local_admin.sh

devpi_local_kaosmaps.sh

This script helps interact with the kaosmaps index on the local DevPI server. It:

• Logs in to the kaosmaps user
• Creates the kaosmaps index if it doesn't exist
• Uploads packages to the index if a pyproject.toml file is present

Usage:

./scripts/devpi_local_kaosmaps.sh

railway_deploy.sh

This script deploys the project to Railway using the Railway CLI.

Usage:

./scripts/dev/railway_deploy.sh

Note: Make sure to run source ./scripts/export_env.sh before using the DevPI-related scripts to ensure the necessary environment variables are set. For the Railway deployment script, ensure you have the Railway CLI installed and are logged in.

Example Usage

After the container is running, you can configure pip to use the DevPI server for package installations:

pip install --index-url http://localhost:3141/<DEVPI_USER>/<DEVPI_INDEX>/simple <package-name>

Deploying to Railway

This project is configured for easy deployment to Railway:

1. Fork this repository to your GitHub account.
2. Connect your forked repository to Railway.
3. Set the following environment variables in Railway:
   • DEVPI_USER
   • DEVPI_PASSWORD
   • DEVPI_KAOSMAPS_USER
   • DEVPI_KAOSMAPS_PASSWORD
   • DEVPI_INDEX
4. Railway will automatically deploy your app when you push changes to the main branch.

For manual deployments, you can use the Railway CLI:

railway up

Contributing

Feel free to open issues or submit pull requests if you'd like to improve this project.

License

This project is licensed under the MIT License.