Restructured entire project

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+ignore = E117,E501,E722,W191
+exclude =
+    tests

.github/workflows/codecov.yml

@@ -11,18 +11,16 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
       - name: Generate coverage report
         run: |
-          pip install pytest
-          pip install pytest-cov
           pytest --cov=./ --cov-report=xml
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1

.github/workflows/flake8.yml

@@ -8,18 +8,14 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
       - name: Lint with flake8
         run: |
-          pip install flake8
-          flake8 --ignore=E117,E501,E722,W191 jeeves.py
-          flake8 --ignore=E117,E501,E722,W191 report.py
-          flake8 --ignore=E117,E501,E722,W191 remind.py
-          flake8 --ignore=E117,E501,E722,W191 functions.py
+          flake8

.github/workflows/pytest.yml

@@ -8,15 +8,14 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
       - name: Test with pytest
         run: |
-          pip install pytest
           pytest

docs/README.md

@@ -71,8 +71,13 @@ To install packages run:
 
 It is recommended you do this within a virtual environment.
 
+## Linting
+Jeeves follows a set of [PEP8](https://www.python.org/dev/peps/pep-0008/) standards in the interest of code clarity and consistency. These rules are enforced with the [flake8](https://flake8.pycqa.org/en/latest/) library. Configuration for linting resides in the `.flake8.ini` file.
+
+To run linting simply run the `flake8` command within the Jeeves directory.
+
 ## Testing
-Jeeves has a small but growing test suite driven by [pytest](https://docs.pytest.org/en/latest/index.html). Currently all tests reside in the `test_functions.py` file.
+Jeeves has a small but growing test suite driven by [pytest](https://docs.pytest.org/en/latest/index.html). Currently all tests reside in the `tests` directory.
 
 To run tests simply run the `pytest` command within the Jeeves directory.