Skip to main content

Coolipy - (Un)oficial Coolify - coolify.io - Python client!

Reason this release was yanked:

broken build

Project description

Coolipy

The first unofficial Python client for the Coolify.
Coolipy simplifies programmatically interacting with Coolify by providing wrappers around Coolify API, enabling you to manage projects, deployments, servers, services, and more with python scripts.

Installation

Install Coolipy using pip:

pip install coolipy

Features

  • Manage Coolify projects, servers, and deployments.
  • Simplify service creation and environment management.
  • 1 dependency: requests.

TO DO:

  • Async support.

Quick Start Guide

  • Import and Initialize
from coolipy import Coolipy

coolify = Coolipy(
    coolify_api_key="your_coolify_api_key",
    coolify_endpoint="your_coolify_instance_address",
)

Example Usage

  • Get Project Information
coolify.projects.get(project_uuid="your_project_uuid")
  • Create a Service
service_data = ServiceModelCreate(
    type=COOLIFY_SERVICE_TYPES.glance,
    name="Example Service",
    project_uuid="your_project_uuid",
    server_uuid="your_server_uuid",
    destination_uuid="your_destination_uuid",
    instant_deploy=True,
    environment_name="production"
)
new_service = coolify.services.create(service_data)
  • List Servers
servers = coolify.servers.list()
  • Create a DB:
postgres_db = PostgreSQLModelCreate(
    project_uuid="your_project_uuid",
    server_uuid="your_server_uuid",
    environment_name="production",
    is_public=False,
    limits_cpu_shares=0,
    limits_cpus=0,
    limits_cpuset=0,
    limits_memory=0,
    limits_memory_reservation=0,
    limits_memory_swap=0,
    limits_memory_swappiness=0,
    instant_deploy=True,
    postgres_user="dbuser",
    postgres_password="password",
    postgres_db="mydatabase",
    name="My PostgreSQL DB",
    postgres_conf="LQ==",  # Example config
    postgres_host_auth_method="-",
    postgres_initdb_args="-"
)

coolify.databases.create(database_model_create=postgres_db)
  • Create an App
app_data = ApplicationPrivateGHModelCreate(
    project_uuid="your_project_uuid",
    server_uuid="your_server_uuid",
    environment_name="production",
    ports_exposes="8080",
    github_app_uuid="your_github_app_uuid",
    git_repository="your_github_repo",
    git_branch="main",
    build_pack=COOLIFY_BUILD_PACKS.dockerfile,
    instant_deploy=True,
    name="MyApp"
)

new_app = coolify.applications.create(app_data)

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

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

coolipy-0.0.2.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

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

coolipy-0.0.2-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file coolipy-0.0.2.tar.gz.

File metadata

  • Download URL: coolipy-0.0.2.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for coolipy-0.0.2.tar.gz
Algorithm Hash digest
SHA256 0c46bdb873497628df765bb6753cd7f84be4556062786bb5cc96f1095e4d186d
MD5 0cd16c81bc75b6afee35080035a7d498
BLAKE2b-256 01a39c705d18d388a151b859e0a012cc83afa36f4305179a4c26c2ef32c23bdb

See more details on using hashes here.

File details

Details for the file coolipy-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: coolipy-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for coolipy-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 59e22f13654cfec26e2a31f7eba78eee0b670ba02498fe57f0b4b2fa2f9cd6a5
MD5 b79c7505e82aaa6b519bef07590fae5c
BLAKE2b-256 331e7f32411cd677d58aea4356c5802ed5e64d7b1d4b5bef4c9f35d33c27374c

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