Merge pull request #1 from frederikhoengaard/initialise-project

Basics

Author: frederikhoengaard

.github/workflows/verify.yaml

@@ -0,0 +1,65 @@
+name: Linting & Testing
+
+on:
+  pull_request:
+
+env:
+  PYTHONPATH: ./python/src/main/
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install pipenv
+        run: |
+          pip install pipenv
+
+      - name: Install packages
+        run: |
+          pipenv sync --dev
+
+      - name: Create test report directory
+        run: |
+          mkdir test-report
+
+      - name: Docker Compose Setup
+        uses: ndeloof/install-compose-action@v0.0.1
+        with:
+          version: v2.13.0
+
+      - name: Run test
+        run: |
+          pipenv run pytest python/src/test --junit-xml=test-report/report.xml
+
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install linters
+        run: |
+          pip install black isort flake8
+
+      - name: black
+        run: |
+          python -m black --check python/src/main/
+
+      - name: isort
+        run: |
+          python -m isort python/src/main/ --multi-line 3 --profile black --check
+
+      - name: flake8
+        run: |
+          python -m flake8 python/src/main/

.gitignore

@@ -6,6 +6,13 @@ __pycache__/
 # C extensions
 *.so
 
+
+# macos
+.DS_Store
+
+# JetBrains
+.idea
+
 # Distribution / packaging
 .Python
 build/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Frederik Peter Høngaard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Pipfile

@@ -0,0 +1,17 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[packages]
+loguru = "==0.6.*"
+pandas = "==1.5.*"
+
+[dev-packages]
+black = "==23.*"
+flake8 = "*"
+isort = "*"
+pytest = "*"
+
+[requires]
+python_version = "3.10"

Pipfile.lock

@@ -1 +1,4 @@
-# easy-model
+# easy-model
+
+---
+