Merge pull request #2 from adnene-guessoum/dev

add: setup pipeline, tests, lint

.github/workflows/ci_pipeline.yml

@@ -0,0 +1,40 @@
+name: percepticron ci pipeline
+
+on: [push, pull-request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }})
+
+      - name: Load cached dependencies
+        id: cached-poetry-dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pypoetry
+          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install Task
+        run: sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip poetry
+          ./bin/task install
+
+      - name: Run linter and tests
+        run: |
+          ./bin/task lint
+          ./bin/task test

.gitignore

@@ -1,2 +1,6 @@
 poetry.lock
 .env
+
+# python package
+__pycache__/
+*.pyc

Taskfile.yml

@@ -0,0 +1,20 @@
+version: 3
+
+tasks:
+  install:
+    desc: Install dependencies (poetry)
+    cmds:
+      - poetry install --no-root
+
+  lint:
+    desc: Lint the code (mypy, black, flake8, pylint)
+    cmds:
+      - poetry run mypy script
+      - poetry run black script
+      - poetry run flake8 script --show-source --statistics --count
+      - poetry run pylint script
+
+  test:
+    desc: Run tests
+    cmds:
+      - poetry run pytest

script/panopticron.py

@@ -3,7 +3,8 @@
 
 def main():
     """TODO"""
-    pass
+    print("TODO")
+    return 0
 
 
 if __name__ == "__main__":

tests/test_panopticron.py

@@ -0,0 +1,11 @@
+"""test file for panopticron.py script"""
+from script import panopticron
+
+
+class TestPanopticron:
+    def test_panopticron(self, capsys):
+        return_value = panopticron.main()
+        capture = capsys.readouterr()
+        assert capture.out == "TODO\n"
+        assert capture.err == ""
+        assert return_value == 0