Add & Configure Flake8 (#10)

* changing after linting

* add

* change github action

* fix github action

* pip flake8 html

* HTML retention day

* pytest html report

Author: cosmicboy79

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+format = html
+htmldir = flake8-report
+count = True
+max-complexity = 10
+statistics = True
+max-line-length = 127

.github/workflows/python-app.yml

@@ -26,14 +26,27 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
+        pip install flake8 flake8-html pytest pytest-html
         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
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --format=html --htmldir=flake8-report
         # 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
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --format=html --htmldir=flake8-report
+    - name: Upload HTML Flake8 report
+      uses: actions/upload-artifact@v4
+      with:
+        name: flake8-html-report
+        path: flake8-report/
+        retention-days: 1
     - name: Test with pytest
       run: |
-        pytest -vv
+        pytest -v --html=pytest-report.html --self-contained-html
+    - name: Upload HTML Pytest report
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-html-report
+        path: pytest-report.html
+        retention-days: 1
+

.gitignore

@@ -197,4 +197,8 @@ cython_debug/
 .idea
 
 # user generated files
-*output.log
+*output.log
+
+# Flake8
+flake8-report
+

src/asynchronous/runner/concurrent.py

@@ -5,11 +5,13 @@
 from asynchronous.runner.task.myasynctask import custom_async_task
 from asynchronous.runner.operation.myoperations import first_operation, second_operation
 
+
 # this coroutine runs both runner concurrently with asyncio.gather()
 async def running_concurrently():
     await asyncio.gather(custom_async_task(first_operation, 3),
                          custom_async_task(second_operation, 2))
 
+
 # starts the event loop, running and waiting for both runner to complete
 def main():
-    asyncio.run(running_concurrently())
+    asyncio.run(running_concurrently())

src/asynchronous/runner/operation/myoperations.py

@@ -2,8 +2,10 @@
 Definition of two simple operations.
 """
 
+
 def first_operation():
     print("First operation")
 
+
 def second_operation():
     print("Second operation")

src/asynchronous/runner/sequential.py

@@ -5,11 +5,14 @@
 from asynchronous.runner.task.myasynctask import custom_async_task
 from asynchronous.runner.operation.myoperations import first_operation, second_operation
 
-# runs two runner sequentially, waiting for one to finish before starting the next
+
+# runs two runner sequentially, waiting for
+# one to finish before starting the next
 async def running_sequentially():
     await custom_async_task(first_operation, 3)
     await custom_async_task(second_operation, 2)
 
+
 # executes both runner, totaling around 5 seconds of runtime
 def main():
     asyncio.run(running_sequentially())

src/asynchronous/runner/task/myasynctask.py

@@ -1,5 +1,6 @@
 import asyncio
 
+
 async def custom_async_task(func, sleep_time):
     """
     Custom asynchronous task (coroutine)
@@ -9,4 +10,4 @@ async def custom_async_task(func, sleep_time):
     print(f"Execution of {func.__name__} started")
     func()
     await asyncio.sleep(sleep_time)
-    print(f"Execution of {func.__name__} completed")
+    print(f"Execution of {func.__name__} completed")

src/asynchronous/tests/usage_test.py

@@ -17,6 +17,7 @@ def test_sequential_run(mock_print):
 
     mock_print.assert_has_calls(order_of_calls, any_order=False)
 
+
 @patch('builtins.print', create=True)
 def test_concurrent_run(mock_print):
     concurrent.main()

src/asynchronous/usage1.py

@@ -1,3 +1,4 @@
 from asynchronous.runner import sequential
 
-sequential.main()
+
+sequential.main()

src/asynchronous/usage2.py

@@ -1,3 +1,4 @@
 from asynchronous.runner import concurrent
 
-concurrent.main()
+
+concurrent.main()