From ce638108fb82038cbb2468461933cdf9382add1f Mon Sep 17 00:00:00 2001
From: Micael Oliveira <micael.oliveira@anu.edu.au>
Date: Wed, 13 Dec 2023 16:01:36 +1100
Subject: [PATCH] Add CI. Includes:  - check for code formatting with black.  -
 linter with flake8.  - tests with python 3.10, 3.11 and 3.12.  - code
 coverage with codecov.

---
 .github/workflows/ci.yml | 55 ++++++++++++++++++++++++++++++++++++++++
 .gitignore               |  1 +
 2 files changed, 56 insertions(+)
 create mode 100644 .github/workflows/ci.yml

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..0d19e4e
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,55 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: OM3Utils
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  formatting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Code formatting
+      uses: psf/black@stable
+      with:
+        options: "--check --verbose"
+        src: "./om3utils ./tests"
+
+  build:
+    needs: formatting
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install '.[devel,test]'
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        python -m pytest
+    - name: Upload coverage reports to Codecov with GitHub Action
+      uses: codecov/codecov-action@v3
+      env:
+        CODEOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.gitignore b/.gitignore
index d77ff57..47b1b99 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,6 +4,7 @@
 /dist
 _version.py
 .coverage
+coverage.xml
 *.egg-info
 .ipynb_checkpoints
 .vscode