Skip to main content

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

Reason this release was yanked:

broken build

Project description

Coolipy

The first (un)official 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.3.tar.gz (7.9 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.3-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: coolipy-0.0.3.tar.gz
  • Upload date:
  • Size: 7.9 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.3.tar.gz
Algorithm Hash digest
SHA256 c218e10db4b90894015d33c538b176f115d3ca82a4c2eb90353f2a51b32ed75e
MD5 631903dc3b55e5a949de421c7e2af769
BLAKE2b-256 a399e86f69ba69a0d40f66a8fd0327eb6e58cf83db3a649e5bfe7bd716dc50a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coolipy-0.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ca633b06313e092c4049ccfe9fc5e8ac835d45a776b4b889fa1d652408b66445
MD5 fadc8f0eac6f38b9f59396abe1771eae
BLAKE2b-256 a8c25306a903f085a613261cf9bb86d9b35b253fdcd8e8f56dc7c423f6d90cea

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