Skip to main content

Docker container management library for Python

Project description

minicloud

Docker container management library for Python. Create and manage VPS containers with SSH access.

Installation

pip install minicloud

Quick Start

from minicloud import CloudManager

cm = CloudManager()

# Create a container
container = cm.create_container(
    name="my-app",
    ram=512,
    cpu=100,
    disk=10,
    port=3000,
    ssh_password="mypassword"
)

print(f"Container ID: {container['container_id']}")

Usage

Create Container

from minicloud import CloudManager

cm = CloudManager()

container = cm.create_container(
    name="my-app",
    ram=512,      # 512 MB RAM
    cpu=100,       # 1 CPU core (100 = 1 core)
    disk=10,       # 10 GB disk
    port=3000,     # SSH port
    image="ubuntu:22.04",
    ssh_password="secure-password"
)

List Containers

containers = cm.list_containers()

for c in containers:
    print(f"{c['name']}: {c['status']}")

Get Container Info

info = cm.get_container_info("my-app")
print(f"Status: {info['status']}")
print(f"Port: {info['port']}")

Get Container Stats

stats = cm.get_container_stats("my-app")
print(f"CPU: {stats['cpu_percent']}%")
print(f"Memory: {stats['memory_used']}/{stats['memory_limit']} MB")

Start/Stop/Restart

cm.start_container("my-app")
cm.stop_container("my-app")
cm.restart_container("my-app")

Delete Container

cm.delete_container("my-app")

Server Info

server = cm.get_server_info()
print(f"Hostname: {server['hostname']}")
print(f"Available RAM: {server['available_ram']} MB")
print(f"Containers: {server['containers_count']}")

Custom Configuration

Custom Prefix

cm = CloudManager(prefix="vps")
# Containers will be named: vps_my-app

Custom Allowed Images

cm = CloudManager(allowed_images=[
    "ubuntu:22.04",
    "debian:12",
    "nginx:latest",
])

Error Handling

from minicloud import CloudManager, ContainerAlreadyExistsError, ImageNotAllowedError

try:
    cm.create_container(
        name="my-app",
        ram=512,
        cpu=100,
        disk=10,
        port=3000
    )
except ContainerAlreadyExistsError:
    print("Container already exists")
except ImageNotAllowedError as e:
    print(f"Image not allowed: {e}")

Available Images

Default allowed images:

  • ubuntu:22.04
  • ubuntu:20.04
  • debian:12
  • debian:11
  • alpine:latest
  • centos:7

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minicloud-1.0.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minicloud-1.0.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file minicloud-1.0.1.tar.gz.

File metadata

  • Download URL: minicloud-1.0.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for minicloud-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2004ac73df8df5f89ed681ee524120b731b60397b854b3f433e67666321a2137
MD5 2527279d2edd012cf8837c3972327173
BLAKE2b-256 9b00533255e20665f897dc22776be7b78399b8ee919961fb400baad85b8c5cd6

See more details on using hashes here.

File details

Details for the file minicloud-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: minicloud-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for minicloud-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b6d689aab30028389a0ed06c8d3466958e18e56207a8d62ff710b693ce512889
MD5 1ca3ef16f53a54ab348457ab7936afaf
BLAKE2b-256 0a65999c3443057bfb4b18dc9e9d38cb2495a7bc9ae455bc22c322a06b0d9804

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page