Merge pull request #1 from netz39/project-setup

Project setup

Author: penguineer

.env.template

@@ -0,0 +1 @@
+PORT=8080

.github/workflows/docker-image.yml

@@ -0,0 +1,61 @@
+name: Docker Image
+
+on:
+  push:
+    branches:
+      - 'main'
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - 'main'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+
+    env:
+      IMAGE_NAME: spaceapi-service
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+          # Needed for correct version detection
+          fetch-depth: 0
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.IMAGE_NAME }}
+          tags: |
+            # 1.2.3
+            type=semver,pattern={{version}}
+            # disabled if major zero
+            type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }}
+            # generate lates from default branch
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/pytest.yml

@@ -0,0 +1,27 @@
+name: PyTest
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Install python
+      uses: actions/setup-python@v5
+      with:
+          python-version: '3.12'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Run tests with pytest
+      run: pytest --verbose

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: "Release"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Check-out"
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: "Generate release changelog"
+        id: generate-release-changelog
+        uses: heinrichreimer/github-changelog-generator-action@v2.3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          onlyLastTag: "true" # set to false if no tags exist (buggy with only one tag)
+          stripHeaders: "true"
+          stripGeneratorNotice: "true"
+      - name: Extract the VERSION name
+        id: get-version
+        run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
+      - name: "Create GitHub release"
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ github.ref }}
+          name: "${{ steps.get-version.outputs.VERSION }}"
+          body: "${{ steps.generate-release-changelog.outputs.changelog }}"
+          prerelease: ${{ startsWith(steps.get-version.outputs.VERSION, 'v0.') }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: True

.gitignore

@@ -0,0 +1,4 @@
+.env
+
+.idea
+venv/

Dockerfile

@@ -0,0 +1,22 @@
+FROM alpine/git AS install
+
+# If the --dirty flag is left out, only the .git directory has to be copied
+ADD . /git/
+RUN git describe --always --dirty > /git-version.txt
+
+
+FROM python:3.12
+
+EXPOSE 8080
+HEALTHCHECK --interval=10s CMD curl --fail http://localhost:8080/v0/health || exit 1
+
+COPY src/OAS3.yml /
+
+COPY requirements.txt /
+RUN pip install -r requirements.txt
+
+COPY src/*.py /
+
+COPY --from=install /git-version.txt /
+
+CMD ["python", "-u", "./app.py"]

README.md

@@ -2,6 +2,41 @@
 
 > Microservice to provide the [Space API](https://spaceapi.io/) JSON from our MQTT topic status.
 
+## Usage
+
+### Configuration
+
+Configuration is done using environment variables:
+
+* `PORT`: Target port when used with docker-compose (default `8080`)
+
+### Run with Docker
+
+```bash
+docker run --rm -it \
+    -p 8080:8080 \
+    netz39/spaceapi-service
+```
+
+### Run with Docker-Compose (Development)
+
+To run with [docker-compose](https://docs.docker.com/compose/) copy  [`.env.template`](.env.template) to `.env` and edit the necessary variables. Then start with:
+
+```bash
+docker-compose up --build
+```
+
+Please note that this compose file will rebuild the image based on the repository. This is helpful during development and not intended for production use.
+
+When done, please don't forget to remove the deployment with
+```bash
+docker-compose down
+```
+
+## Maintainers
+
+* Stefan Haun ([@penguineer](https://github.com/penguineer))
+
 
 ## License
 

docker-compose.yml

@@ -0,0 +1,16 @@
+# Do not forget to create the .env file (see template)
+# before using this container!
+
+version: '2'
+
+services:
+    collector:
+        restart: always
+        build: .
+        environment:
+            PORT: 8080
+        ports:
+            - $PORT:8080
+
+volumes:
+    db:

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+asyncio_mode = strict
+pythonpath = "src/"

requirements.txt

@@ -0,0 +1,4 @@
+pytest==7.1.2
+pytest-asyncio==0.19.0
+tornado==6.4.1
+isodate==0.6.0