Merge branch 'main' of github.com:troiwill/py-histogram-filter

.github/workflows/code_format_check.yml

@@ -0,0 +1,24 @@
+name: Code Formatting Check
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    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 pylint black==23.9.1
+    - name: Analysing the code with black and pylint
+      run: |
+        black --diff --check $(git ls-files '*.py')
+        pylint --disable=all --enable=unused-import $(git ls-files '*.py')

README.md

@@ -3,7 +3,7 @@
 This package provides a base class and tools for implementing a Bayes Histogram Filter. Users would need to implement
 the `histogram.predict(...)` and `histogram.update(...)` methods.
 
-This code was inspired by the code here (https://irwinsnet.github.io/probrob/nb07.html).
+This code was inspired by [this code](https://irwinsnet.github.io/probrob/nb07.html).
 
 ### How To Set Up
 Run the following commands to install this package. **Note**: This package was developed using Python 3.8.