Merge pull request #416 from PyPSA/misc/precommit-ci-2

Add pre-commit CI

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: PyPSA Mailing List
-    url: https://groups.google.com/forum/#!forum/pypsa
-    about: Please ask and answer general usage questions here.
+- name: PyPSA Mailing List
+  url: https://groups.google.com/forum/#!forum/pypsa
+  about: Please ask and answer general usage questions here.

.github/workflows/ci.yaml

@@ -16,7 +16,7 @@ on:
     branches:
     - master
   schedule:
-    - cron: "0 5 * * TUE"
+  - cron: "0 5 * * TUE"
 
 env:
   CACHE_NUMBER: 1 # Change this value to manually reset the environment cache
@@ -28,63 +28,73 @@ jobs:
       matrix:
         include:
           # Matrix required to handle caching with Mambaforge
-          - os: ubuntu-latest
-            label: ubuntu-latest
-            prefix: /usr/share/miniconda3/envs/pypsa-eur
+        - os: ubuntu-latest
+          label: ubuntu-latest
+          prefix: /usr/share/miniconda3/envs/pypsa-eur
 
-          - os: macos-latest
-            label: macos-latest
-            prefix: /Users/runner/miniconda3/envs/pypsa-eur
+        - os: macos-latest
+          label: macos-latest
+          prefix: /Users/runner/miniconda3/envs/pypsa-eur
 
-          - os: windows-latest
-            label: windows-latest
-            prefix: C:\Miniconda3\envs\pypsa-eur
+        - os: windows-latest
+          label: windows-latest
+          prefix: C:\Miniconda3\envs\pypsa-eur
 
     name: ${{ matrix.label }}
 
     runs-on: ${{ matrix.os }}
-    
+
     defaults:
       run:
         shell: bash -l {0}
-        
+
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup secrets
-        run: |
-          echo -ne "url: ${CDSAPI_URL}\nkey: ${CDSAPI_TOKEN}\n" > ~/.cdsapirc
-
-      - name: Add solver to environment
-        run: |
-          echo -e "  - glpk\n  - ipopt<3.13.3" >> envs/environment.yaml
-
-      - name: Setup Mambaforge
-        uses: conda-incubator/setup-miniconda@v2
-        with:
-            miniforge-variant: Mambaforge
-            miniforge-version: latest
-            activate-environment: pypsa-eur
-            use-mamba: true
-
-      - name: Set cache date
-        run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
-
-      - name: Create environment cache
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ${{ matrix.prefix }}
-          key: ${{ matrix.label }}-conda-${{ hashFiles('envs/environment.yaml') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
-
-      - name: Update environment due to outdated or unavailable cache
-        run: mamba env update -n pypsa-eur -f envs/environment.yaml
-        if: steps.cache.outputs.cache-hit != 'true'
-
-      - name: Test snakemake workflow
-        run: |
-          conda activate pypsa-eur
-          conda list
-          cp test/config.test1.yaml config.yaml
-          snakemake --cores all solve_all_networks
-          rm -rf resources/*.nc resources/*.geojson resources/*.h5 networks results
+    - uses: actions/checkout@v2
+
+    - name: Setup secrets
+      run: |
+        echo -ne "url: ${CDSAPI_URL}\nkey: ${CDSAPI_TOKEN}\n" > ~/.cdsapirc
+
+    - name: Add solver to environment
+      run: |
+        echo -e "- glpk\n- ipopt" >> envs/environment.yaml
+
+    - name: Add solver to environment
+      run: |
+        echo -e "- glpk\n- ipopt<3.13.3" >> envs/environment.yaml
+      if: ${{ matrix.label }} == 'windows-latest'
+
+    - name: Add solver to environment
+      run: |
+        echo -e "- glpk\n- ipopt" >> envs/environment.yaml
+      if: ${{ matrix.label }} != 'windows-latest'
+
+    - name: Setup Mambaforge
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        miniforge-variant: Mambaforge
+        miniforge-version: latest
+        activate-environment: pypsa-eur
+        use-mamba: true
+
+    - name: Set cache date
+      run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
+
+    - name: Create environment cache
+      uses: actions/cache@v2
+      id: cache
+      with:
+        path: ${{ matrix.prefix }}
+        key: ${{ matrix.label }}-conda-${{ hashFiles('envs/environment.yaml') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
+
+    - name: Update environment due to outdated or unavailable cache
+      run: mamba env update -n pypsa-eur -f envs/environment.yaml
+      if: steps.cache.outputs.cache-hit != 'true'
+
+    - name: Test snakemake workflow
+      run: |
+        conda activate pypsa-eur
+        conda list
+        cp test/config.test1.yaml config.yaml
+        snakemake --cores all solve_all_networks
+        rm -rf resources/*.nc resources/*.geojson resources/*.h5 networks results

.pre-commit-config.yaml

@@ -0,0 +1,83 @@
+exclude: "^LICENSES"
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.3.0
+  hooks:
+  - id: check-merge-conflict
+  - id: end-of-file-fixer
+  - id: fix-encoding-pragma
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+  - id: check-added-large-files
+    args: ["--maxkb=2000"]
+
+  # Sort package imports alphabetically
+- repo: https://github.com/PyCQA/isort
+  rev: 5.10.1
+  hooks:
+  - id: isort
+    args: ["--profile", "black", "--filter-files"]
+
+  # Convert relative imports to absolute imports
+- repo: https://github.com/MarcoGorelli/absolufy-imports
+  rev: v0.3.1
+  hooks:
+  - id: absolufy-imports
+
+  # Find common spelling mistakes in comments and docstrings
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.1
+  hooks:
+  - id: codespell
+    args: ['--ignore-regex="(\b[A-Z]+\b)"', '--ignore-words-list=fom'] # Ignore capital case words, e.g. country codes
+    types_or: [python, rst, markdown]
+    files: ^(scripts|doc)/
+
+  # Make docstrings PEP 257 compliant
+- repo: https://github.com/myint/docformatter
+  rev: v1.5.0
+  hooks:
+  - id: docformatter
+    args: ["--in-place", "--make-summary-multi-line", "--pre-summary-newline"]
+
+- repo: https://github.com/keewis/blackdoc
+  rev: v0.3.5
+  hooks:
+  - id: blackdoc
+
+  # Formatting with "black" coding style
+- repo: https://github.com/psf/black
+  rev: 22.8.0
+  hooks:
+      # Format Python files
+  - id: black
+      # Format Jupyter Python notebooks
+  - id: black-jupyter
+
+  # Remove output from Jupyter notebooks
+- repo: https://github.com/aflc/pre-commit-jupyter
+  rev: v1.2.1
+  hooks:
+  - id: jupyter-notebook-cleanup
+    args: ["--remove-kernel-metadata"]
+
+  # Do YAML formatting (before the linter checks it for misses)
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.4.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, "2", --preserve-quotes]
+
+  # Format Snakemake rule / workflow files
+- repo: https://github.com/snakemake/snakefmt
+  rev: 0.4.4
+  hooks:
+  - id: snakefmt
+
+  # For cleaning jupyter notebooks
+- repo: https://github.com/aflc/pre-commit-jupyter
+  rev: v1.2.1
+  hooks:
+  - id: jupyter-notebook-cleanup
+    exclude: examples/solve-on-remote.ipynb

.readthedocs.yml

@@ -7,5 +7,5 @@ version: 2
 python:
   version: 3.8
   install:
-    - requirements: doc/requirements.txt
+  - requirements: doc/requirements.txt
   system_packages: true

.syncignore-receive

@@ -16,4 +16,4 @@ notebooks
 doc
 cutouts
 data/bundle
-*.nc
+*.nc