Update cicd job name, fix issue with macos, lint and update readme (#11)

* Update cicd job name, fix issue with macos, lint and update readme

Signed-off-by: rafsaf <rafal.safin12@gmail.com>

* update push rule

Signed-off-by: rafsaf <rafal.safin12@gmail.com>

---------

Signed-off-by: rafsaf <rafal.safin12@gmail.com>

Author: rafsaf

.github/workflows/docker_build.yml …hub/workflows/docker_build_and_tests.yml.github/workflows/docker_build.yml renamed to .github/workflows/docker_build_and_tests.yml .github/workflows/docker_build.yml renamed to .github/workflows/docker_build_and_tests.yml

@@ -1,4 +1,4 @@
-name: docker_build
+name: docker_build_and_tests
 on:
   push:
     branches:
@@ -15,7 +15,7 @@ permissions:
   contents: read
 
 jobs:
-  docker_build:
+  docker_build_and_tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/type_check.yml

@@ -2,9 +2,12 @@ name: type-check
 on:
   push:
     branches:
-      - "**"
+      - "main"
     tags-ignore:
       - "*.*"
+  pull_request:
+    branches:
+      - main
 
 permissions:
   actions: write

README.md

@@ -3,7 +3,7 @@
 [![Docker Pulls](https://img.shields.io/docker/pulls/rafsaf/medichaser.svg)](https://hub.docker.com/r/rafsaf/medichaser)
 [![Latest release](https://img.shields.io/github/v/release/rafsaf/medichaser)](https://github.com/rafsaf/medichaser/releases/latest)
 
-MediChaser is a tool for automating Medicover appointment searches. It uses Selenium to interact with the Medicover website, handling login and MFA, and sends notifications when appointments are found.
+MediChaser is a tool for automating Medicover appointment searches. It interacts with the Medicover website, handles login and MFA, and sends notifications when appointments are found.
 
 The application is designed to be run in a Docker container and includes a `ttyd` web terminal for remote management.
 
@@ -203,6 +203,20 @@ You can secure `ttyd` by:
 
 ---
 
+## Development
+
+```bash
+# 1. install poetry
+poetry install
+# 2. hack
+# 3. lint directly or install pre-commit hooks with poetry run pre-commit install
+poetry run pre-commit run -a
+# 4. run tests
+poetry run pytest
+```
+
+---
+
 ## Acknowledgements
 
 This project stands on the shoulders of giants. Big thanks to the original authors and inspirations:

docker-compose.tests.yml

@@ -8,3 +8,4 @@ services:
       dockerfile: Dockerfile
     env_file:
       - .env.example
+    platform: "linux/amd64"

docker-compose.yml

@@ -11,6 +11,6 @@ services:
       - medichaser_data:/app/data
     ports:
       - 7681:7681
-
+    platform: "linux/amd64"
 volumes:
   medichaser_data:

notifications.py

@@ -27,6 +27,7 @@
 pushover = get_notifier("pushover")
 telegram = get_notifier("telegram")
 
+
 def prowl_notify(message: str, title: str | None = None) -> None:
     if not environ.get("NOTIFIERS_PROWL_API_KEY"):
         print(
@@ -48,6 +49,7 @@ def prowl_notify(message: str, title: str | None = None) -> None:
     except requests.exceptions.RequestException as e:
         print(f"Prowl notification failed:\n{e}")
 
+
 def pushbullet_notify(message: str, title: str | None = None) -> None:
     try:
         if title is None: