Skip to main content

Caprover API

https://img.shields.io/pypi/v/caprover_api.svg https://img.shields.io/travis/ak4zh/caprover_api.svg Documentation Status

unofficial caprover api to deploy apps to caprover

Features

  • create app

  • add custom domain

  • enable ssl

  • update app with port mappings, env variables, repo info etc

  • deploy one click apps

  • get list of all apps

  • get app by name

  • delete app

  • delete app and it’s volumes

  • stop app

  • scale app

Usage

To use Caprover API in a project:

from caprover_api import caprover_api

cap = caprover_api.CaproverAPI(
    dashboard_url="cap-dashboard-url",
    password="cap-dashboard-password"
)

One Click Apps

get app name from List of one-click-apps

automated deploy:

app_variables = {
    "$$cap_redis_password": "REDIS-PASSWORD-HERE"
}
cap.deploy_one_click_app(
    one_click_app_name='redis',
    namespace='new-app',
    app_variables=app_variables,
    automated=True
)

manual deploy (you will be asked to enter required variables during runtime):

cap.deploy_one_click_app(
    one_click_app_name='redis',
    namespace='new-app',
)

Custom Apps

create a new app:

cap.create_app(
    app_name="new-app",
    has_persistent_data=False
)

create and deploy redis app from docker hub:

cap.create_and_update_app(
    app_name="new-app-redis",
    has_persistent_data=False,
    image_name='redis:5',
    volumes=['new-app-redis-data:/data', ]
)

History

0.1.0 (2021-06-11)

  • First release on PyPI.

Download files

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

Source Distribution

caprover_api-0.1.9.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

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

caprover_api-0.1.9-py2.py3-none-any.whl (8.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file caprover_api-0.1.9.tar.gz.

File metadata

  • Download URL: caprover_api-0.1.9.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.6

File hashes

Hashes for caprover_api-0.1.9.tar.gz
Algorithm Hash digest
SHA256 bc5cab45f5326853a2c832fbfb2cccef36432699546e7ad613dd82d810dc3930
MD5 442cfe82bf1b2a58f552036625284038
BLAKE2b-256 e1d626488837516420cb87151d87e39141565883a7c087c0484304bc3373a6e0

See more details on using hashes here.

File details

Details for the file caprover_api-0.1.9-py2.py3-none-any.whl.

File metadata

  • Download URL: caprover_api-0.1.9-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.6

File hashes

Hashes for caprover_api-0.1.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c0debc02f38acc619c62301c62bea956dc1659059bbd51a5a890930d6fd54b15
MD5 be465cb267439f77d6439017bd742ee4
BLAKE2b-256 2015a2ee2fcdfceab7111723f99dbb05e6f996bf2b427e880afce0e20976eab3

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 Sentry Error logging StatusPage Status page