Dokku API
This is a REST API for managing applications and resources on Dokku, built with FastAPI.
Installing Dokku API from PyPI:
$ pip install dokku-api
$ dokku-api help
Getting Started (quick run)
The entire project has been built to run entirely on Dokku or Docker.
For installing and running the API as a Dokku application:
$ dokku plugin:install https://github.com/JeanExtreme002/Dokku-API.git
$ dokku dokku-api:start
For installing and running the API on Docker:
Create a .env from .env.sample, configure the variables, and execute one of the commands below to run the application:
$ make docker-run
Now, open the API on your browser at http://dokku-api.yourdomain — if you did not change the default settings.
$ curl 'http://dokku-api.yourdomain/api/'
Access /docs for more information about the API.
Getting Started (development)
Install the dependencies for the project:
$ pip install poetry
$ make install
Now, you can run the server with:
$ make run
Run make help to learn about more commands.
Running Tests
The project has some tests to check if everything is working properly. To run the tests, execute the command below:
$ make test
$ make system-test
Coding Style
Run the commands below to properly format the project's code:
$ make lint
$ make lint-fix
1 maintainer
Metadata
1 maintainer
Release files for dokku-api 1.3.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dokku_api-1.3.12.tar.gz | 102.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dokku_api-1.3.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 243.1 kB
Release files / dokku_api-1.3.12.tar.gz
| Download URL | dokku_api-1.3.12.tar.gz |
|---|---|
| Size | 102.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
365062f30f284c70df9bc59b0f2e50bca4a8b9f340c069b9de75c6585636cbd5
|
|
BLAKE2b-256 checksum How to use checksums |
4505aa52da19fdde6c9f33e72b90ffc75875e8eee0b1e727a07fb2c6446bb3a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.0
|
Release files / dokku_api-1.3.12-py3-none-any.whl
| Download URL | dokku_api-1.3.12-py3-none-any.whl |
|---|---|
| Size | 140.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cf271d5969dd24f91850e2b9b05db8d2f89022b8597b55cdf89399076d62e06f
|
|
BLAKE2b-256 checksum How to use checksums |
af3c639e296da67852660883b8874187218a6568bca4ad42afc6d26484aceae4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.0
|
