python-linters 0.1.0__tar.gz → 0.1.2__tar.gz

python_linters-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tilo Himmelsbach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{python_linters-0.1.0 → python_linters-0.1.2}/PKG-INFO

@@ -1,7 +1,8 @@
 Metadata-Version: 2.1
 Name: python-linters
-Version: 0.1.0
+Version: 0.1.2
 Summary: bundling config files for linters like ruff and flake8
+Home-page: https://github.com/dertilo/python-linters
 Author: Tilo Himmelsbach
 Author-email: dertilo@gmail.com
 Requires-Python: >=3.10,<4.0
@@ -15,9 +16,13 @@ Requires-Dist: flake8-newspaper-style (>=0.4.3,<0.5.0)
 Requires-Dist: ruff (>=0.0.291)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
 Requires-Dist: wemake-python-styleguide (>=0.18.0,<0.19.0)
+Project-URL: Repository, https://github.com/dertilo/python-linters
 Description-Content-Type: text/markdown
 
-# python-linter
+![pypi](https://github.com/dertilo/python-linters/actions/workflows/release.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
+# python-linters
 - bundles flake8, black, isort, ruff into a single poetry-script
 - project independent linter configuration (via `ruff.toml`,`.flake8`) -> one config to rule them all
 ### use-cases:
@@ -38,9 +43,9 @@ python-linters = { version = "<some-version-here>" }
          { include = "my_package_name" }, 
      ]
      ```
-   b. or via `tool.python-linter`
+   b. or via `tool.python-linters`
     ```toml
-    [tool.python-linter]
+    [tool.python-linters]
     folders_to_be_linted=["my_directory","another_dir/my_sub_package"]
     ```
 ## 2. local development workflow (before pushing to ci-pipeline)

{python_linters-0.1.0 → python_linters-0.1.2}/README.md

@@ -1,4 +1,7 @@
-# python-linter
+![pypi](https://github.com/dertilo/python-linters/actions/workflows/release.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
+# python-linters
 - bundles flake8, black, isort, ruff into a single poetry-script
 - project independent linter configuration (via `ruff.toml`,`.flake8`) -> one config to rule them all
 ### use-cases:
@@ -19,9 +22,9 @@ python-linters = { version = "<some-version-here>" }
          { include = "my_package_name" }, 
      ]
      ```
-   b. or via `tool.python-linter`
+   b. or via `tool.python-linters`
     ```toml
-    [tool.python-linter]
+    [tool.python-linters]
     folders_to_be_linted=["my_directory","another_dir/my_sub_package"]
     ```
 ## 2. local development workflow (before pushing to ci-pipeline)

{python_linters-0.1.0 → python_linters-0.1.2}/pyproject.toml

@@ -1,9 +1,10 @@
 [tool.poetry]
 name = "python-linters"
-version = "0.1.0"
+version = "0.1.2"
 description = "bundling config files for linters like ruff and flake8"
 authors = ["Tilo Himmelsbach <dertilo@gmail.com>"]
 readme = "README.md"
+repository = "https://github.com/dertilo/python-linters"
 packages = [{ include = "python_linters" }]
 
 include=["python_linters/.flake8","python_linters/ruff.toml"]

{python_linters-0.1.0 → python_linters-0.1.2}/python_linters/ruff.toml

@@ -1,4 +1,6 @@
 target-version = "py310"
+[lint.isort]
+profile = "black"
 # Exclude a variety of commonly ignored directories. see https://beta.ruff.rs/docs/configuration/#using-pyprojecttoml
 [lint]
 exclude = [
@@ -110,10 +112,12 @@ ignore = [
     "RET505", # encurages bad practice of ommitting the "else"-clause
     "RUF100", # RUF100 unused-noqa: ruff does not know about flake8 codes
     "UP008", # see: https://stackoverflow.com/questions/73268995/typeerror-when-calling-super-in-dataclassslots-true-subclass
+    "RET506", # looks like a false-positive
+    "SLF001", # everybody knows about the _-conventin, if one still accesses "protected" attributes one has their reasons!
 ]
 
 [lint.mccabe]
-# Flag errors (`C901`) whenever the complexity level exceeds 5.
+# Flag errors (`C901`) whenever the complexity level exceeds some threshold.
 # ruffs default is 10
 # PyCQA default seems to be 7: https://github.com/PyCQA/mccabe/blob/60cf21c21f8e5880f9907561c53732e80d1be400/mccabe.py#L273
 # flake8's default is 10: https://flake8.pycqa.org/en/2.5.5/

{python_linters-0.1.0 → python_linters-0.1.2}/python_linters/run_linters.py

@@ -40,9 +40,9 @@ packages = [
     { include = \"my_package_name\" },
 ]
 
-b. or via tool.python-linter
+b. or via tool.python-linters
 
-[tool.python-linter]
+[tool.python-linters]
 folders_to_be_linted=["my_directory","another_dir/my_sub_package"]"""
         super().__init__(msg)
 
@@ -56,7 +56,7 @@ def get_folders_to_be_linted(pyproject_toml: str) -> list[str]:
     with open(pyproject_toml) as f:
         t = toml.load(f)
         folders = (
-            t.get("tool", {}).get("python-linter", {}).get("folders_to_be_linted", None)
+            t.get("tool", {}).get("python-linters", {}).get("folders_to_be_linted", None)
         )
         if (
             folders is None