Merge pull request #55 from signaux-faibles/develop

M: merge in main for 21.03 release

Author: vviers

.env.example

@@ -0,0 +1,4 @@
+MONGO_URL=mongodb://your_mongo_url
+MONGO_DB=the_name_of_thedb
+MONGO_COLLECTION=my_awesome_data
+MIN_EFFECTIF=10

.gitattributes

@@ -0,0 +1 @@
+notebooks/*.ipynb filter=strip-notebook-output

.githooks.ini

@@ -0,0 +1,5 @@
+[pre-commit]
+command = python3 -m black . && pylint ./**/*.py
+
+[pre-push]
+command = pytest

.github/workflows/.gitkeep

@@ -0,0 +1,28 @@
+name: Test
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+      - develop
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run pylint
+        run: |
+          python -m pylint --rcfile=./.pylintrc ./**/*.py
+      - name: Test with pytest
+        run: |
+          python -m pytest
+        env:
+          MIN_EFFECTIF: 10

.github/workflows/test.yml

@@ -14,7 +14,6 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
 lib64/
 parts/
 sdist/
@@ -127,3 +126,14 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# ignore notebooks prefaced with "dev"
+notebooks/dev-*
+notebooks/val-*
+
+# ignore documentation file of variables
+variables.json
+
+# ignore model run outputs
+model_runs/*
+.vscode