[INFRA] Add automatic release to Pypi (#10)

.github/workflows/publish.yaml

@@ -0,0 +1,27 @@
+name: publish
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Build distribution
+        run: pipx run build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

src/clinicaio/hello.py

@@ -1,4 +1,7 @@
-__all__ = ["greet"]
+__all__ = [
+    "greet",
+    "say_goodbye",
+]
 
 
 def greet(name: str):
@@ -14,3 +17,18 @@ def greet(name: str):
 
 def _build_greeting_message(name: str) -> str:
     return f"Hello {name} !"
+
+
+def say_goodbye(name: str):
+    """Say goodbye to the person with the provided name.
+
+    Parameters
+    ----------
+    name : str
+        The name of the person to say goodbye to.
+    """
+    print(_build_good_bye_message(name))
+
+
+def _build_good_bye_message(name: str) -> str:
+    return f"Goodbye {name} !"

tests/unittests/test_hello.py

@@ -14,3 +14,21 @@ def test_greet(capsys):
 
     captured = capsys.readouterr()
     assert captured.out == "Hello John Doe !\n"
+
+
+def test_build_good_bye_message():
+    from clinicaio.hello import _build_good_bye_message
+
+    assert (
+        _build_good_bye_message("ClinicaIO developers")
+        == "Goodbye ClinicaIO developers !"
+    )
+
+
+def test_say_goodbye(capsys):
+    from clinicaio.hello import say_goodbye
+
+    say_goodbye("John Doe")
+
+    captured = capsys.readouterr()
+    assert captured.out == "Goodbye John Doe !\n"