Skip to content

Commit 9fb5e2f

Browse files
committed
read me update and toml with docs link
1 parent 062edde commit 9fb5e2f

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
**The first (un)official Python client for the [Coolify](https://coolify.io/).**
44
Coolipy simplifies programmatically interacting with Coolify by providing wrappers around [Coolify API](https://coolify.io/docs/api), enabling you to manage projects, deployments, servers, services, and more with python scripts.
55

6+
- Lib docs: https://coolipydocs.gabrielbocchini.com.br/
7+
- Coolify API docs: https://coolify.io/docs/api
8+
69
## Installation
710

811
Install Coolipy using pip:
@@ -14,13 +17,17 @@ pip install coolipy
1417
## Features
1518
- Manage Coolify projects, servers, applications, deployments and more (everything the Coolify App offers)ç
1619
- Infra as code;
17-
- 1 dependency: requests>=2.32.3.
20+
- 1 dependency: requests>=2.32.3;
21+
- Datamodels for all endpoints;
22+
- Datamodels specific for creation with only the required fields;
23+
- All responses come from Datamodels;
1824

1925
TO DO:
2026

2127
- Async support.
2228

2329

30+
2431
# Quick Start Guide
2532

2633
- Import and Initialize
@@ -88,7 +95,7 @@ postgres_db = PostgreSQLModelCreate(
8895
postgres_initdb_args="-"
8996
)
9097

91-
coolify_client.databases.create(database_model_create=postgres_db)
98+
my_database = coolify_client.databases.create(database_model_create=postgres_db)
9299
```
93100

94101
- Create an App
@@ -108,9 +115,18 @@ app_data = ApplicationPrivateGHModelCreate(
108115
name="MyApp"
109116
)
110117

111-
new_app = coolify.applications.create(app_data)
118+
new_app = coolify_client.applications.create(app_data)
112119
```
113120

121+
# Contributing
122+
123+
- Before opening a pull request or issue, take some time to understand if the issue should be treated at
124+
this client level OR the Coolify REST API;
125+
- Create a fork of this repo and then submit a pull request;
126+
- Respect Python PEPs and type inference;
127+
- Test your code or changes introduced and deliver unit tests on the PR;
128+
- No breaking changes unless if necessary due Coolipy REST API change (please provide Coolipy PR/commits of the change).
129+
114130

115131
# License
116132

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
66

77
[project]
88
name = "coolipy"
9-
version = "0.0.3"
9+
version = "0.0.4"
1010
authors = [
1111
{ name="Gabriel Bocchini", email="gabrielbocchini@gmail.com" },
1212
]
@@ -24,6 +24,8 @@ dependencies = [
2424

2525
[project.urls]
2626
Homepage = "https://github.com/gbbocchini/coolipy"
27+
Documentation = "https://coolipydocs.gabrielbocchini.com.br/"
28+
2729

2830
[tool.setuptools.packages.find]
2931
where = ["."]

0 commit comments

Comments
 (0)