Merge pull request #6 from modeseven-os-climate/update-readme

Chore: Add heading to README.md

Author: ModeSevenIndustrialSolutions

.markdownlint.yaml

@@ -0,0 +1,10 @@
+---
+# Markdownlint configuration file
+
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+MD013: false

.pre-commit-config.yaml

@@ -1,66 +1,151 @@
 ---
+ci:
+  autofix_commit_msg: "Chore: pre-commit autoupdate"
+  skip:
+    # pre-commit.ci cannot install WGET, so tomlint must be disabled
+    - tomllint
+
+exclude: |
+  (?x)^(
+      docs\/conf.py|
+      dco-signoffs/$
+  )$
+
 repos:
-  - repo: git://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.1.10
+  - repo: local
     hooks:
-      - id: remove-tabs
+      - id: tomllint
+        name: "Script: scripts/tomllint.sh"
+        language: script
+        # pass_filenames: false
+        files: \^*.toml
+        types: [file]
+        entry: scripts/tomllint.sh .
 
-  - repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
     hooks:
-      - id: trailing-whitespace
-      - id: check-merge-conflict
-      - id: end-of-file-fixer
-      - id: name-tests-test
-      - id: check-byte-order-marker
+      - id: check-added-large-files
+      - id: check-ast
       - id: check-case-conflict
-      - id: check-docstring-first
+      - id: check-executables-have-shebangs
       - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
       - id: check-symlinks
-      - id: detect-private-key
-      - id: check-ast
+      - id: check-toml
+      # - id: detect-aws-credentials
+      - id: check-xml
+      - id: check-yaml
       - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+      - id: no-commit-to-branch
+      # - id: pretty-format-json
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        args: ["--no-error-on-unmatched-pattern", "--ignore-unknown"]
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.41.0
+    hooks:
+      - id: markdownlint
+        args: ["--fix"]
+
+  - repo: https://github.com/jorisroovers/gitlint
+    rev: v0.19.1
+    hooks:
+      - id: gitlint
+
+  - repo: https://github.com/openstack/bashate
+    rev: 2.1.1
+    hooks:
+      - id: bashate
+        args: ["--ignore=E006,E011"]
 
-  - repo: git://github.com/pycqa/pydocstyle.git
-    rev: 6.1.1
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+
+  - repo: https://github.com/pycqa/pydocstyle.git
+    rev: 6.3.0
     hooks:
       - id: pydocstyle
+        additional_dependencies: ["tomli"]
 
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+  - repo: https://github.com/Mateusz-Grzelinski/actionlint-py
+    rev: v1.7.1.15
     hooks:
-      - id: check-toml
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
+      - id: actionlint
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.902
+  - repo: https://github.com/pycqa/flake8
+    rev: "7.1.0"
     hooks:
-      - id: mypy
-        exclude: '^(docs|tasks|tests)|setup\.py'
-        args: [--ignore-missing-imports]
+      - id: flake8
+        additional_dependencies:
+          - pep8-naming
 
-  - repo: https://github.com/psf/black
-    rev: 21.6b0
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.35.1
     hooks:
-      - id: black
+      - id: yamllint
+        args:
+          [
+            "-d",
+            "{rules: {line-length: {max: 120}}, ignore-from-file: [.gitignore],}",
+          ]
 
-  - repo: https://github.com/tomcatling/black-nb
-    rev: '0.5.0'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.9
     hooks:
-      - id: black-nb
+      - id: ruff
+        files: ^(scripts|tests|custom_components)/.+\.py$
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+        files: ^(scripts|tests|custom_components)/.+\.py$
 
-  # Enable this in repositories with python packages.
-  # - repo: https://github.com/mgedmin/check-manifest
-  #   rev: '0.39'
-  #   hooks:
-  #     - id: check-manifest
+  - repo: local
+    hooks:
+      - id: mypy-cache
+        name: "create mypy cache"
+        language: system
+        pass_filenames: false
+        entry: bash -c 'if [ ! -d .mypy_cache ]; then /bin/mkdir .mypy_cache; fi; exit 0'
 
-  - repo: https://github.com/s-weigand/flake8-nb
-    rev: v0.3.0
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.10.0"
     hooks:
-      - id: flake8-nb
-        additional_dependencies: ['pep8-naming']
-        # Ignore all format-related checks as Black takes care of those.
-        args: ['--ignore', 'E2,W5', '--select', 'E,W,F,N', '--max-line-length=120']
+      - id: mypy
+        verbose: true
+        args: ["--show-error-codes", "--install-types", "--non-interactive"]
+        additional_dependencies: ["pytest", "types-requests"]
+
+  # Check for misspellings in documentation files
+  # - repo: https://github.com/codespell-project/codespell
+  #   rev: v2.2.2
+  #   hooks:
+  #   - id: codespell
+
+  # To embrace black styles, even in docs
+  # - repo: https://github.com/asottile/blacken-docs
+  #   rev: v1.13.0
+  #   hooks:
+  #   - id: blacken-docs
+  #     additional_dependencies: [black]
+
+  # Automatically upgrade Python syntax for newer versions
+  # - repo: https://github.com/asottile/pyupgrade
+  #   rev: v3.15.0
+  #   hooks:
+  #     - id: pyupgrade
+  #       args: ['--py37-plus']

README.md

@@ -1,10 +1,8 @@
-project-template
-==============================
+# wri-gppd-ingestion-pipeline
 
 template for the team to use
 
-Project Organization
-------------
+## Project Organization
 
     ├── LICENSE
     ├── Makefile           <- Makefile with commands like `make data` or `make train`
@@ -55,7 +53,6 @@ Project Organization
     ├── .aicoe-ci.yaml     <- AICoE CI configuration file (https://github.com/AICoE/aicoe-ci)
     └── tox.ini            <- tox file with settings for running tox; see tox.readthedocs.io
 
+---
 
---------
-
-<p><small>Project based on the <a target="_blank" href="https://drivendata.github.io/cookiecutter-data-science/">cookiecutter data science project template</a>. #cookiecutterdatascience</small></p>
+Project based on the [cookiecutter](https://drivendata.github.io/cookiecutter-data-science/) data science project template