Feature/nav 150 extract python viewer 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/docker-ci.yml

@@ -0,0 +1,19 @@
+name: Docker CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build image
+        run: |
+          COMMIT_HASH=$(git rev-parse --short HEAD)
+          IMAGE_TAG=ghcr.io/${{ github.repository }}:${COMMIT_HASH}
+          docker build . --file Dockerfile --tag $IMAGE_TAG

.github/workflows/docker-publish.yml

@@ -0,0 +1,36 @@
+name: Docker publish
+
+on:
+  release:
+    types: [ created ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Login to ghcr
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata for image tag
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}"
+
+      - name: Build and push image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.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
+
+      - 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

naviqore_client/.vscode/settings.json → .vscode/settings.json

@@ -2,15 +2,22 @@
   "editor.formatOnPaste": false,
   "editor.formatOnSave": true,
   "[python]": {
-    "editor.rulers": [88],
+    "editor.rulers": [
+      88
+    ],
     "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.formatOnSave": true
   },
   "python.analysis.autoFormatStrings": true,
   "python.analysis.typeCheckingMode": "strict",
   "editor.defaultFormatter": "ms-python.black-formatter",
-  "black-formatter.args": ["--line-length", "88"],
-  "python.testing.pytestArgs": ["tests"],
+  "black-formatter.args": [
+    "--line-length",
+    "88"
+  ],
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
   "python.testing.unittestEnabled": false,
   "python.testing.pytestEnabled": true
 }

Dockerfile

@@ -0,0 +1,25 @@
+# Stage 1: Builder Stage
+FROM python:3.12-slim AS builder
+
+WORKDIR /app
+
+COPY . .
+
+RUN pip install --no-cache-dir poetry \
+    && poetry build -f wheel
+
+# Stage 2: Production Stage
+FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY --from=builder /app/dist/*.whl ./
+RUN pip install --no-cache-dir *.whl \
+    && rm *.whl
+
+EXPOSE 8501
+
+RUN useradd --create-home appuser
+USER appuser
+
+CMD ["ptv-deploy"]

README.md

@@ -1,2 +1,49 @@
-# public-transit-viewer
-A public transit viewer streamlit app
+# Public Transit Viewer
+
+Viewer to interact with the [Public Transit Service](https://github.com/naviqore/public-transit-service).
+
+The streamlit based Python app allows users to query connections between two stops or generate isolines from a specific
+stop. The application supports the query parameters of the service to search specific connections or isoline.
+
+## Installation
+
+Get the current release from pypi and start the viewer:
+
+```sh
+pip install public-transit-viewer
+
+export NAVIQORE_SERVICE_URL=<SERVER:PORT>
+ptv-deploy
+```
+
+Or run the viewer inside a Docker container:
+
+```sh
+docker run -p 8501:8501 -e NAVIQORE_SERVICE_URL=<SERVER:PORT> ghcr.io/naviqore/public-transit-client:latest
+```
+
+Access the viewer on `http://localhost:8501`.
+
+## Development
+
+### Configuration
+
+Create a `.env` file in the root directory. And add a line telling the application to which service host it should
+connect. In Local Development this is typically a Java Spring service running on `http://localhost:8080`.
+
+The required line in the `.env` file will then be: `NAVIQORE_SERVICE_URL=http://localhost:8080`
+
+**Note**: you can also specify the `NAVIQORE_SERVICE_URL` in your operating system environment.
+
+### Starting the App
+
+To start the app in development mode run following command from the root directory:
+
+```sh
+poetry run streamlit run public_transit_viewer/connections.py
+```
+
+## License
+
+This project is licensed under the MIT License - see
+the [LICENSE](https://github.com/naviqore/public-transit-viewer/blob/main/LICENSE) file for details.