dokku-api 1.3.3

A REST API for managing applications and resources on a Dokku platform.

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