https://github.com/jeanextreme002/dokku-api

A RESTful API for managing applications and resources on a Dokku platform.
https://github.com/jeanextreme002/dokku-api

api application-server container dokku fastapi paas rest

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jeanextreme002/dokku-api
• Owner: JeanExtreme002
• License: mit
• Created: 2025-05-21T17:10:00.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-03T20:26:28.000Z (12 months ago)
• Last Synced: 2025-06-08T13:41:19.418Z (12 months ago)
• Topics: api, application-server, container, dokku, fastapi, paas, rest
• Language: Python
• Homepage:
• Size: 215 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Dokku API

This is a REST API for managing applications and resources on Dokku, built with [FastAPI](https://fastapi.tiangolo.com/).

[![CI](https://github.com/JeanExtreme002/Dokku-API/actions/workflows/ci.yml/badge.svg)](https://github.com/JeanExtreme002/Dokku-API/actions/workflows/ci.yml)

[![Pypi](https://img.shields.io/pypi/v/dokku-api)](https://pypi.org/project/dokku-api/)

[![License](https://img.shields.io/pypi/l/Dokku-API)](https://github.com/JeanExtreme002/Dokku-API)

[![Python Version](https://img.shields.io/badge/python-3.11+-yellow)](https://pypi.org/project/dokku-api/)

[![OS](https://img.shields.io/badge/os-Linux-red)](https://pypi.org/project/dokku-api/)

[![Platform](https://img.shields.io/badge/platform-Dokku-8A2BE2)](https://pypi.org/project/dokku-api/)

[![Downloads](https://static.pepy.tech/personalized-badge/dokku-api?period=total&units=international_system&left_color=grey&right_color=orange&left_text=downloads)](https://pypi.org/project/dokku-api/)

### 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](https://dokku.com/) or [Docker](https://www.docker.com/).

#### 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](http://dokku-api.yourdomain) — if you did not change the default settings.

```

$ curl 'http://dokku-api.yourdomain/api/'

```

Access [/docs](http://dokku-api.yourdomain/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

```