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',
    persistent_directories=['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.21.tar.gz (22.4 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.21-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: caprover_api-0.1.21.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.7.1 requests/2.26.0 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for caprover_api-0.1.21.tar.gz
Algorithm Hash digest
SHA256 dc378fd9e631fa1a1b8fab8fdd5aa0c82086ac120014c0214171055db6e9d22d
MD5 a0b607e48a6f80ab6ebf65061d21c9e1
BLAKE2b-256 edbde6e3d501f338b25d0884f35330143432e3602af21be80d0a161f4df33737

See more details on using hashes here.

File details

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

File metadata

  • Download URL: caprover_api-0.1.21-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.7.1 requests/2.26.0 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for caprover_api-0.1.21-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dad9d2a7d2e8b50bf5bc73a255daf803b19a85f74e8b11655b996c500fb0d47e
MD5 455db253cc98ab2275560613f92a5a37
BLAKE2b-256 0a63a1317fe7e24a8bee0f3bdf4b3491e43d56e86d75456ffb9cc2fdea7323cf

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