apiminio 0.2.2

apiminio is a Python package that provides a ready-to-use REST API for interacting with MinIO S3 storage, built with FastAPI and the MinIO Python client. It enables seamless file uploads, downloads, and bucket management via HTTP interface ideal for integrating MinIO S3 into your applications with minimal setup.

apiminio

apiminio is a Python package that provides a ready-to-use REST API for interacting with MinIO S3 storage, built with FastAPI and the MinIO Python client. It enables seamless file uploads, downloads, and bucket management via HTTP interface ideal for integrating MinIO S3 into your applications with minimal setup.

• Github repository: https://github.com/raederan/apiminio/
• Documentation https://raederan.github.io/apiminio/

📄 Table of Contents

• 📚 Project
• 🚦 Prerequisites
• 🚀 Install
• 💥 Usage 🌰🐿️
• 🥐 Recommended Dev Setup Kubernetes
• 🛞 Commands
• 📜 License
• 🦥 Authors

📚 Project

1. At 1st basic implementation of apiminio, handling buckets and files will be focused.
2. Security will be at the 2nd development stage using authenticated sessions by credentials as well as tokens.
3. Certificate handling and TLS will be the 3rd level.

🚦 Prerequisites

• minio endpoint, access key, and secret key
• Recommended Dev Setup
  • Kubernetes
  • kubectl
  • Skaffold

🚀 Install

Recommended

uv add apiminio

or use pip

pip install apiminio

💥 Usage 🌰🐿️

Create your python file, e.g., apiminio_server.py, configure your S3 server like:

from apiminio import Apiminio, MinioConfig
from pydantic import SecretStr

app = Apiminio(
    config=MinioConfig(
        endpoint="localhost:9000",
        access_key="minioadmin",
        secret_key=SecretStr("minioadmin"),
        secure=False
    )
)

if __name__ == "__main__":
    # Serve FastAPI using Uvicorn
    import uvicorn

    uvicorn.run("minimal:app", host="0.0.0.0", port=8000, reload=True)

Either just run python apiminio_server.py or use fastapi run apiminio_server.py.

You can use flags and parmeters inherited from FastAPI to deploy your apiminio server via Uvicorn 🦄🐍

🥐 Recommended Dev Setup Kubernetes

This repository has a skaffold.yaml configuration with a working minio as well as the apiminio service to bootstrap the development 😎🙌

🛞 Commands

To clone this repository, run:

git clone https://github.com/raederan/apiminio.git

To instantly provide minio with apiminio, e.g., run:

skaffold dev --no-prune=false --cache-artifacts=false --default-repo localhost:32000/apiminio --port-forward

📜 License

This project is licensed under the terms of the Apache License 2.0.

The banner file is based on an original png generated using Microsoft Copilot and subsequently modified further as svg by the initial author of this repository.

🦥 Authors

Andreas Räder