Caprover API
unofficial caprover api to deploy apps to caprover
Free software: MIT license
Full Documentation: https://caprover-api.readthedocs.io.
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.24 (2024-12-16)
Fix & test update from novel kwargs (#12)
update method lets you set httpAuth (#11)
update() now handles persistent directories that use hostPath (#7)
gen_random_hex works across whole one-click-app YAML (#6)
Bugfix: update() should not change notExposeAsWebApp (#8)
Enable SSL on base domain (#9)
Allow optional override one-click repository path (#5)
0.1.0 (2021-06-11)
First release on PyPI.
1 maintainer
Metadata
1 maintainer
Release files for caprover-api 0.1.24
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| caprover_api-0.1.24.tar.gz | 21.4 kB | Without provenance | Details for caprover_api-0.1.24.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| caprover_api-0.1.24-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for caprover_api-0.1.24-py2.py3-none-any.whl |
Total release size: 33.0 kB
Release files / caprover_api-0.1.24.tar.gz
| Download URL | caprover_api-0.1.24.tar.gz |
|---|---|
| Size | 21.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a98eb88b0b00d2d50fd96d84b6ddf95959fc65368eefe05fef045b60750507c3
|
|
BLAKE2b-256 checksum How to use checksums |
36e48a9f1f39413a4b1f2b969d19c0b11400d78690d5accd2ad5ae1c161c4bf7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.5
|
Release files / caprover_api-0.1.24-py2.py3-none-any.whl
| Download URL | caprover_api-0.1.24-py2.py3-none-any.whl |
|---|---|
| Size | 11.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c0e215744c9511801bf28e555edb3d775babed2342599698f510f4493b530461
|
|
BLAKE2b-256 checksum How to use checksums |
f9086006e8dc163b571fd1bbdac06cd129a3d6e9a2cfe6469d671e5818b40fa6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.5
|
Security for caprover-api 0.1.24
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
