Merge pull request #31 from Quantmetry/dev

Dev

Author: JulienRoussel77

.flake8

@@ -1,7 +1,7 @@
 [flake8]
 exclude = .git,__pycache__,.vscode,tests
 max-line-length=99
-ignore=E302,E305,W503,E203,E731,E402,E501,E266,E712,F401,F821
+ignore=E302,E305,W503,E203,E731,E402,E266,E712,F401,F821
 indent-size = 4
 per-file-ignores=
     qolmat/imputations/imputers.py:F401

.github/workflows/test.yml

@@ -1,37 +1,37 @@
 name: Unit test Qolmat
 
-on: [push, pull_request,workflow_dispatch]
-
+on: [push, pull_request, workflow_dispatch]
 
 jobs:
   build-linux:
     runs-on: ${{matrix.os}}
     strategy:
       matrix:
-        os: [ubuntu-latest,windows-latest]
-        python-version: [3.8,3.9]
+        os: [ubuntu-latest, windows-latest]
+        python-version: [3.8, 3.9]
     defaults:
       run:
         shell: bash -l {0}
 
     steps:
-    - name: Git clone
-      uses: actions/checkout@v3
-    - name: Set up venv for ci
-      uses: conda-incubator/setup-miniconda@v2
-      with:
-        python-version: ${{matrix.python-version}}
-        channels: default, conda-forge
-    - name: Lint with flake8
-      run: |
-        conda install flake8
-        flake8
-    - name: Test with pytest
-      run: |
-        conda install pytest
-        #pytest
-        echo you should uncomment pytest and delete this line
-    - name: typing with mypy
-      run: |
-        #mypy qolmat
-        echo you should uncomment mypy qolmat and delete this line
+      - name: Git clone
+        uses: actions/checkout@v3
+      - name: Set up venv for ci
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          python-version: ${{matrix.python-version}}
+          environment-file: environment.ci.yml
+          channels: default, conda-forge
+      - name: Lint with flake8
+        run: |
+          conda install flake8
+          flake8
+      - name: Test with pytest
+        run: |
+          conda install pytest
+          pytest
+          echo you should uncomment pytest and delete this line
+      - name: typing with mypy
+        run: |
+          mypy qolmat
+          echo you should uncomment mypy qolmat and delete this line

.gitignore

@@ -6,7 +6,9 @@ __pycache__/
 .DS_Store
 .mypy*
 
-
+# documentation specific
+docs/_build/
+docs/generated/
 
 # Distribution / packaging
 

.pre-commit-config.yaml

@@ -12,11 +12,14 @@ repos:
     rev: 22.8.0
     hooks:
       - id: black
-        exclude: (tests/)
         args:
           - "-l 99"
   # Flake8
   - repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
     hooks:
       - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.1.1
+    hooks:
+      - id: mypy

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2023, Hong-Lan BOTTERMAN, Julien ROUSSEL, Thomas MORZADEC, Rima HAJOU, Firas DAKHLI and qolmat contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.