Feature/nav 145 extract python client package

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/poetry-ci.yml

@@ -0,0 +1,48 @@
+name: Poetry CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.12 ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "${HOME}/.local/bin" >> $GITHUB_PATH
+
+      - name: Set up cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            .venv
+            ~/.cache/pypoetry
+          key: poetry-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        run: |
+          poetry config virtualenvs.in-project true
+          poetry install --no-interaction --no-root
+
+      - name: Run unit tests
+        run: poetry run pytest -m unit
+
+      - name: Run mypy
+        run: poetry run mypy .

.github/workflows/poetry-publish.yml

@@ -0,0 +1,37 @@
+name: Poetry Publish
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "${HOME}/.local/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          poetry config virtualenvs.in-project true
+          poetry install --no-interaction --no-root
+
+      - name: Build the package
+        run: |
+          poetry build
+
+      - name: Publish to PyPI
+        env:
+          TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry publish --username __token__ --password $TOKEN --no-interaction --build

README.md

@@ -1,2 +1,66 @@
-# public-transit-client
-Client to access the public transit service.
+# Public Transit Client
+
+Client to access the [Public Transit Service](https://github.com/naviqore/public-transit-service) API endpoints.
+
+It is designed to interact seamlessly with the service, offering easy-to-use methods to query
+transit information and connections.
+
+## Installation
+
+To install the package, you can use pip:
+
+```sh
+pip install public-transit-client
+```
+
+## Usage
+
+Here's a basic example of how to use the client:
+
+```python
+from public_transit_client.client import PublicTransitClient
+
+client = PublicTransitClient("http://localhost:8080")
+response = client.get_stop("NANAA")
+print(response)
+```
+
+See the integration tests for more examples.
+
+## Testing
+
+This project uses pytest for both unit and integration testing. The tests are organized into separate folders to ensure
+clarity and separation of concerns.
+
+### Unit Tests
+
+Unit tests are designed to test individual components in isolation. To run the unit tests, simply execute:
+
+```sh
+poetry run pytest -m unit
+```
+
+### Integration Tests
+
+Integration tests ensure that the components work together as expected in a more realistic environment. These tests
+require the service to be running, usually within a Docker container.
+
+**Step 1: Start the Docker Compose Environment**
+
+First, start the necessary services using Docker Compose:
+
+```sh
+docker compose up -d
+```
+
+**Step 2: Run Integration Tests**
+
+Once the services are up and running, execute the integration tests with:
+
+```sh
+poetry run pytest -m integration
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3.8'
+
+services:
+  public-transit-service:
+    image: ghcr.io/naviqore/public-transit-service:latest
+    container_name: public-transit-service
+    ports:
+      - "8080:8080"
+    environment:
+      - GTFS_STATIC_URI=https://developers.google.com/static/transit/gtfs/examples/sample-feed.zip
+    healthcheck:
+      test: [ "CMD-SHELL", "curl -f http://localhost:8080/actuator/health | grep '\"status\":\"UP\"' || exit 1" ]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 30s
+    restart: unless-stopped