From 27d1fc67a09ff038184744b54a2191f7f0a53de3 Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 5 Jun 2025 18:24:16 +0300 Subject: [PATCH 1/4] README: Add installation instructions on Debian Signed-off-by: Povilas Kanapickas --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index c181218..2a5ec3b 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,12 @@ curl -o ~/.local/bin/podman-compose https://raw.githubusercontent.com/containers chmod +x ~/.local/bin/podman-compose ``` +or install from Debian repositories: + +```bash +sudo apt install podman-compose +``` + or install from Fedora (starting from f31) repositories: ```bash From 93371b0f4efe01af2c8ef8fc91e4dace78f2e6be Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 5 Jun 2025 18:24:17 +0300 Subject: [PATCH 2/4] README: Merge all repositories under single section Signed-off-by: Povilas Kanapickas --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2a5ec3b..f111a45 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,23 @@ Or latest development version from GitHub: pip3 install https://github.com/containers/podman-compose/archive/main.tar.gz ``` -### Homebrew +### Package repositories + +podman-compose is available from the following package repositories: + +Debian: + +```bash +sudo apt install podman-compose +``` + +Fedora (starting from f31) repositories: + +```bash +sudo dnf install podman-compose +``` + +Homebrew: ```bash brew install podman-compose @@ -94,18 +110,6 @@ curl -o ~/.local/bin/podman-compose https://raw.githubusercontent.com/containers chmod +x ~/.local/bin/podman-compose ``` -or install from Debian repositories: - -```bash -sudo apt install podman-compose -``` - -or install from Fedora (starting from f31) repositories: - -```bash -sudo dnf install podman-compose -``` - ## Basic Usage We have included fully functional sample stacks inside `examples/` directory. From bbdb63604eb85066755c9ebf108c93f97ea40c07 Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 5 Jun 2025 18:24:18 +0300 Subject: [PATCH 3/4] README: Update section on tests Signed-off-by: Povilas Kanapickas --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f111a45..65c8a6c 100644 --- a/README.md +++ b/README.md @@ -139,16 +139,20 @@ There is also AWX 17.1.0 ## Tests -Inside `tests/` directory we have many useless docker-compose stacks -that are meant to test as many cases as we can to make sure we are compatible +podman-compose is tested via unit and integration tests. -### Unit tests with unittest -run a unittest with following command +Unit tests can be run via the following: ```shell python3 -m unittest discover tests/unit ``` +Integration tests can be run via the following: + +```shell +python3 -m unittest discover tests/integration +``` + # Contributing guide If you are a user or a developer and want to contribute please check the [CONTRIBUTING](CONTRIBUTING.md) section From 034b86ea736ccec9e5ffab3cbe99425b3801ca07 Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Thu, 5 Jun 2025 18:24:19 +0300 Subject: [PATCH 4/4] README: Remove basic usage section There are plenty of resources on compose format, no need to repeat anything. Beginners won't be helped by the examples and experienced users will look into better places anyway. Signed-off-by: Povilas Kanapickas --- README.md | 27 --------------------------- 1 file changed, 27 deletions(-) diff --git a/README.md b/README.md index 65c8a6c..cdb879f 100644 --- a/README.md +++ b/README.md @@ -110,33 +110,6 @@ curl -o ~/.local/bin/podman-compose https://raw.githubusercontent.com/containers chmod +x ~/.local/bin/podman-compose ``` -## Basic Usage - -We have included fully functional sample stacks inside `examples/` directory. -You can get more examples from [awesome-compose](https://github.com/docker/awesome-compose). - -A quick example would be - -```bash -cd examples/busybox -podman-compose --help -podman-compose up --help -podman-compose up -``` - -A more rich example can be found in [examples/awx3](examples/awx3) -which have - -- A Postgres Database -- RabbitMQ server -- MemCached server -- a django web server -- a django tasks - - -When testing the `AWX3` example, if you got errors, just wait for db migrations to end. -There is also AWX 17.1.0 - ## Tests podman-compose is tested via unit and integration tests.