Merge pull request #2 from Hart-House-Chess-Club/develop

updates for ratings calculations

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# 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: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - 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: |
+        pytest

README.md

@@ -5,8 +5,11 @@ Calculate ratings based on the CFC model.
 This program was created to calculate CFC ratings for our members. A future implementation would be in embeding this information onto a web service that will automatically calculate ratings. Another idea is to build a HHCC rating system to let our members play each other in-person. 
 
 ## About
+
 Started in Fall 2022 with Hart House Chess Club Executive Board member Victor Zheng. 
 
+Updated in December 2023.
+
 ## How 
 This program runs by calculating CFC ratings from the publicly accessible CFC algorithm viewable on the [CFC handbook](https://github.com/Hart-House-Chess-Club/ratings-calculator/blob/main/CFC%20-%20CFC%20Handbook%20(to%202014).pdf).