Better path handling and pypi releases (#11)

* Better path handling

* Self-publish to pypi

Author: niosus

.github/workflows/main.yml

@@ -38,10 +38,10 @@ jobs:
         pipenv install
     - name: Lint with Black linter
       run: >
-        pipenv run black homework_checker --check --diff
+        pipenv run black homework_checker/**/*.py --check --diff
     - name: Run unit tests
       run: >
-        pipenv run python3 -m unittest discover -v homework_checker/tests/
+        pipenv run python3 -m unittest discover -v homework_checker/core/tests/
     - name: Upload result md file
       uses: actions/upload-artifact@v2
       with:
@@ -69,3 +69,29 @@ jobs:
         git commit -m "Update results"
         git push
 
+  publish_to_pypi:
+    needs: run_tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+        architecture: 'x64'
+    - name: Install pypa/build
+      run: python3 -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish package
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -24,3 +24,6 @@ build/
 /coverage.xml
 
 !Pipfile
+dist/
+/result.md
+/results.md

README.md

@@ -2,4 +2,23 @@
 
 This is a python module and script that can be used to check homeworks.
 
-To be completed later
+The idea behind the script is the following:
+- There is a homework yaml file, see [`homework.yml`](homework_checker/core/tests/data/homework/example_job.yml) that follows the [schema](schema/schema.yml)
+- In this file we define the structure of the homework
+- The homework checker library knows how to execute certain types of tasks following the guides in the yaml file
+
+It is expected that the submitted homework will follow the folder structure specified in the `homework.yml` file. 
+
+## Core funcionality ##
+
+### Run different tests ###
+For now we support running tests for code written in different languages:
+- c++
+- bash
+
+### Inject data into homeworks ###
+We sometimes want to inject a certain folder before running tests, there is an option to do this here.
+
+## How it works ##
+
+I will probably not go into details here at this level of the package maturity. For now you can start digging from the [`check_homework.py`](homework_checker/check_homework.py) script and hopefully the code is clear enough. You can also look at the [`homework.yml`](homework_checker/core/tests/data/homework/example_job.yml) file that we use to test all the implemented functionality.

check_homework.py renamed to homework_checker/check_homework.py

@@ -4,9 +4,14 @@
 import logging
 from pathlib import Path
 
-from homework_checker.checker import Checker
-from homework_checker.md_writer import MdWriter
-
+if __name__ == "__main__":
+    from core.checker import Checker
+    from core.md_writer import MdWriter
+    from core.tools import expand_if_needed
+else:
+    from homework_checker.core.checker import Checker
+    from homework_checker.core.md_writer import MdWriter
+    from homework_checker.core.tools import expand_if_needed
 
 logging.basicConfig()
 log = logging.getLogger("GHC")
@@ -32,15 +37,15 @@ def main():
     if args.verbose:
         log.setLevel(logging.DEBUG)
         log.debug("Enable DEBUG logging.")
-    # Read the job file.
-    log.debug('Reading from file "%s"', args.input)
-    checker = Checker(Path(args.input))
+    input_file = expand_if_needed(Path(args.input))
+    log.debug('Reading from file "%s"', input_file)
+    checker = Checker(input_file)
     results = checker.check_all_homeworks()
     md_writer = MdWriter()
     md_writer.update(results)
-    # Write the resulting markdown file.
-    log.debug('Writing to file "%s"', args.output)
-    md_writer.write_md_file(args.output)
+    output_file = expand_if_needed(Path(args.output))
+    log.debug('Writing to file "%s"', output_file)
+    md_writer.write_md_file(output_file)
 
 
 if __name__ == "__main__":

homework_checker/tests/__init__.py renamed to homework_checker/core/__init__.py

@@ -30,11 +30,13 @@ def __init__(self: "Checker", job_file_path: Path):
         self._checked_code_folder = tools.expand_if_needed(
             Path(self._base_node[Tags.FOLDER_TAG])
         )
+        log.debug("self._checked_code_folder: %s", self._checked_code_folder)
 
     def check_homework(self: "Checker", homework_node: dict) -> HomeworkResultDict:
         """Run over all Tasks in a single homework."""
         results: HomeworkResultDict = {}
         current_folder = Path(self._checked_code_folder, homework_node[Tags.FOLDER_TAG])
+        log.debug("current_folder: %s", current_folder)
         if not current_folder.exists():
             log.warning("Folder '%s' does not exist. Skiping.", current_folder)
             return results