From bc1296031e71cde15b8cab9416163febe0fb9d4a Mon Sep 17 00:00:00 2001
From: Murali Suriar <code@suriar.net>
Date: Wed, 28 Dec 2022 13:44:27 +0000
Subject: [PATCH] BLD: Remove pylint (#28)

As per #20. This removes all references to `pylint` in favour of relying
on whatever opinionated standards which `black` has gone with.

- Remove Github Actions Workflow
- Remove pylint section in pyproject.toml
- Update README section on contributing to be more generic. ("Make
  sure all configured github actions pass" rather than naming specific
  checks).

I haven't touched `flake8` for now, since in theory it catches a bunch
of stuff which black doesn't care about, but which generally keeps
codebases clean (e.g. checking for unused variables, imports etc). My
instinct is to leave flake8 in place, unless people very strongly feel
otherwise.
---
 .github/workflows/pylint.yml | 23 -----------------------
 README.md                    |  4 ++--
 pyproject.toml               | 14 +-------------
 3 files changed, 3 insertions(+), 38 deletions(-)
 delete mode 100644 .github/workflows/pylint.yml

diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
deleted file mode 100644
index 7e112f7..0000000
--- a/.github/workflows/pylint.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-name: Check Code Style - FLAKE8
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-      - name: Install Dependencies
-        run: |
-          # These packages are installed in the base environment but may be older
-          # versions. Explicitly upgrade them because they often create
-          # installation problems if out of date.
-          # python -m pip install --upgrade
-
-          pip install pylint
-      - name: Run flake8
-        run: |
-          # always pass this so we get the report without failing CI
-          # eventually remove --exit-zero
-          pylint tid --exit-zero
diff --git a/README.md b/README.md
index d18de55..a2dbd47 100644
--- a/README.md
+++ b/README.md
@@ -15,8 +15,8 @@ Following this, you should be able to install the requirements with
 `python -m pip install -r requirements.txt`
 
 ## Contributing
-Please ensure pylint and mypy are happy before pushing code.
-In the near future we can add in some tests and some github actions to enforce this.
+Please ensure all configured github workflows are green before requesting
+review.
 
 ## Authors
 Because of the refactor, this branch wiped out a lot of author information.
diff --git a/pyproject.toml b/pyproject.toml
index 60cbec6..bc25930 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -65,18 +65,6 @@ module = [
 ]
 ignore_missing_imports = true
 
-[tool.pylint.'MESSAGES CONTROL']
-max-line-length = 100
-max-attributes = 12
-max-args = 10
-max-locals = 20
-min-public-methods = 0
-# accepted short names: i,j,k for iteration
-# t for time
-# f1,f2 for frequencies
-good-names = ["i,j,k,t,f1,f2"]
-ignore = ["tests"]
-
 [tool.coverage.run]
 source = ["tid"]
 
@@ -90,4 +78,4 @@ omit = [
 ]
 exclude_lines = [
     "if __name__ == '__main__':"
-]
\ No newline at end of file
+]