diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..364cd74 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,6 @@ +[run] +omit = + src/apps/* + src/rule/* + src/model/* + */__init__.py \ No newline at end of file diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..3273f13 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,39 @@ +name: ๐Ÿš€ IDEAL | test / cov + +on: + push: + branches: + - master + pull_request: + branches: + - master + - dev + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build the Docker image + run: docker build . -t ideal + - name: ๐Ÿงช Run Tests in Docker Container + run: docker run -t -w /app ideal pytest + - name: Archive code coverage results + uses: actions/upload-artifact@v3 + with: + name: code-coverage-report + path: coverage.json + + cov: + runs-on: ubuntu-latest + needs: build + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Download a single artifact + uses: actions/download-artifact@v3 + - name: ๐Ÿ“ค Upload coverage to Codecov + uses: codecov/codecov-action@v3 + with: + token: ${{ secrets.CODECOV_TOKEN }} diff --git a/.gitignore b/.gitignore index ae6db1a..cbd67d1 100644 --- a/.gitignore +++ b/.gitignore @@ -140,6 +140,13 @@ coverage.xml .pytest_cache/ cover/ +# IDEAL Input Files +IDEAL_Results.csv +IDEAL_Results.xlsx + +# Greet +.greet + # Translations *.mo *.pot @@ -226,3 +233,4 @@ dmypy.json # Cython debug symbols cython_debug/ +coverage.json \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index e3ca386..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Datasource local storage ignored files -/../../../../:\Projects\ProjectSunshine\.idea/dataSources/ -/dataSources.local.xml -# Editor-based HTTP Client requests -/httpRequests/ diff --git a/.idea/ProjectSunshine.iml b/.idea/ProjectSunshine.iml deleted file mode 100644 index 74d515a..0000000 --- a/.idea/ProjectSunshine.iml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml deleted file mode 100644 index 105ce2d..0000000 --- a/.idea/inspectionProfiles/profiles_settings.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index 1701f26..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 2e9b42d..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 94a25f7..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..577b02d --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "[python]": { + "editor.defaultFormatter": "ms-python.autopep8", + "editor.formatOnSave": true + } +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4e7fb16 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# IDEAL | CONTRIBUTING + +## Commits + +We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history +We follow specs described by [Conventional Commits](https://www.conventionalcommits.org/). + +The following is taken from https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines + +### Commit Message Format + +Each commit message consists of a `header`, a `body` and a `footer`. The header has a special format that includes a `type` and a `subject`: +Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools. + +``` +: + + + +