Adding GH Actions Formatting CI Check and GH Pages for Docs (#41)

* Adding GH Actions Formatting CI Check and GH Pages for Docs

* Remove dups

Author: Maxusmusti

.github/workflows/python-app.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python application
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+        pip install pytest-dependency
+        pip install pytest-mock
+        pip install black==22.3.0
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Check formatting with black
+      run: |
+        black --check .

README.md

@@ -16,6 +16,13 @@ For testing, make sure to have installed:
 
 NOTE: Self-contained unit/functional tests coming soon, will live in `tests` folder
 
+For formatting:
+ - Currently using black v22.3.0 for format checking
+ - To install, run `pip install black==22.3.0`
+ - To check file formatting, in top-level dir run `black --check .`
+   - To auto-reformat all files, remove the `--check` flag
+   - To reformat an individual file, run `black <filename>`
+
 To build the python package:
- - If poetry is not installed: `pip3 install poetry`
+ - If poetry is not installed: `pip install poetry`
  - `poetry build`