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.20.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.20-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: caprover_api-0.1.20.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.20.tar.gz
Algorithm Hash digest
SHA256 1c999188ab76a157298ba75865ad91e0b1a8dc09d9e36865a952a4e83e54b885
MD5 bfb0493f6e9a5b04f22c255b2bd786e7
BLAKE2b-256 a897fbee22e340c8f0db6719728ce42c520dd3fda9ac83fc621653bbf06afc5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: caprover_api-0.1.20-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.20-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dce7b1e6166450ec805aaed775cb94b7fae1c5441106d111f20d9a49edc3fad9
MD5 fd040d1bc7c343dfc364fa6ea3992b43
BLAKE2b-256 739bb1e88b7b85ac7f4c8523fbfe625240c0c486cae951425222b5bc41a96dda

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