Merge pull request #76 from timvink/73_filter_tables

Use `pyproject.toml`  syntax

.github/workflows/pythonpublish.yml

@@ -27,8 +27,7 @@ jobs:
     
     - name: Make sure unit tests succeed
       run: |
-        pip install -r tests/test_requirements.txt
-        pip install .
+        pip install ".[dev]"
         pytest
     
     - name: Build

.github/workflows/workflow.yml

@@ -15,15 +15,9 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Static code checking with pyflakes
-      run: |
-        pip install pyflakes
-        pyflakes mkdocs_table_reader_plugin
-
     - name: Run unit tests
       run: |
-        pip install -r tests/test_requirements.txt
-        pip install -e .
+        pip install ".[dev]"
         pytest --cov=mkdocs_table_reader_plugin --cov-report=xml
 
     - name: Upload coverage to Codecov

pyproject.toml

@@ -0,0 +1,117 @@
+[build-system]
+requires = ["setuptools>=70.0", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project.entry-points."mkdocs.plugins"]
+"table-reader" = "mkdocs_table_reader_plugin.plugin:TableReaderPlugin"
+
+[project]
+name="mkdocs_table_reader_plugin"
+keywords = ["mkdocs", "plugin"]
+authors = [
+    { name = "Tim Vink", email = "[email protected]" }
+]
+license = { text = "MIT" }
+
+description="MkDocs plugin to directly insert tables from files into markdown."
+readme = { file = "README.md", content-type = "text/markdown" }
+
+requires-python=">=3.8"
+
+classifiers=[
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: MIT License",
+]
+
+dynamic = ["version","dependencies","optional-dependencies"]
+
+[project.urls]
+"Homepage" = "https://github.com/timvink/mkdocs-table-reader-plugin"
+
+[tool.setuptools.dynamic]
+version = {attr = "mkdocs_table_reader_plugin.__version__"}
+
+dependencies={file = ["requirements.txt"]}
+
+optional-dependencies.dev={file = ["requirements_dev.txt"]}
+optional-dependencies.base={file = ["requirements.txt"]}
+optional-dependencies.all={file = ["requirements.txt", "requirements_dev.txt"]}
+
+[tool.pytest.ini_options]
+markers = [
+    "integration: marks tests as integration, meaning they use databases (deselect with '-m \"not integration\"')",
+    "serial",
+    "no_temp_caching",
+]
+
+# https://github.com/charliermarsh/ruff
+[tool.ruff]
+
+# Rules to apply
+lint.select= ["E", "F", "I", "UP"]
+
+# Exclude rules
+lint.ignore = ['D104'
+        ,'D212'
+        ,'D200'
+        ,'D412'
+        ,'E731'
+        ,'E501'
+        ,'E722'
+        ,'D104'
+        ,'E402'
+        ,"UP038" # UP038 Use `X | Y` in `isinstance` call instead of `(X, Y)`
+]
+
+# Exclude files in tests dir
+lint.exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+]
+
+# Set line length, keep same as black
+line-length = 120
+
+extend-exclude = [
+        "*.yml",
+        "*.toml",
+        "*.md",
+        ".json",
+        "Makefile",
+        "*.txt",
+]
+
+ #supported for python 3.10
+target-version = "py310" 
+
+# Always autofix
+fix = true
+
+[tool.uv]
+dev-dependencies = [
+    "ruff",
+]

requirements.txt

@@ -0,0 +1,4 @@
+mkdocs>=1.0
+pandas>=1.1
+tabulate>=0.8.7
+PyYAML>=5.4.1

tests/test_requirements.txt → requirements_dev.txt

@@ -6,7 +6,7 @@ xlrd>=1.0.0
 openpyxl
 pyarrow
 # linting
-pyflakes
+ruff
 # documentation
 mkdocs-macros-plugin
 mkdocs-material

src/mkdocs_table_reader_plugin/__init__.py

@@ -0,0 +1 @@
+__version__ = "3.1.0"

mkdocs_table_reader_plugin/markdown.py → src/mkdocs_table_reader_plugin/markdown.py

@@ -1,8 +1,8 @@
 import re
-from typing import Dict
-import pandas as pd
 import textwrap
 
+import pandas as pd
+
 
 def replace_unescaped_pipes(text: str) -> str:
     """
@@ -19,7 +19,7 @@ def replace_unescaped_pipes(text: str) -> str:
     return re.sub(r"(?<!\\)\|", "\\|", text)
 
 
-def convert_to_md_table(df: pd.DataFrame, **markdown_kwargs: Dict) -> str:
+def convert_to_md_table(df: pd.DataFrame, **markdown_kwargs: dict) -> str:
     """
     Convert dataframe to markdown table using tabulate.
     """

mkdocs_table_reader_plugin/plugin.py → src/mkdocs_table_reader_plugin/plugin.py

@@ -1,12 +1,12 @@
 import re
 
-from mkdocs.plugins import BasePlugin, get_plugin_logger
 from mkdocs.config import config_options
 from mkdocs.exceptions import ConfigurationError
+from mkdocs.plugins import BasePlugin, get_plugin_logger
 
+from mkdocs_table_reader_plugin.markdown import add_indentation, convert_to_md_table, fix_indentation
+from mkdocs_table_reader_plugin.readers import MACROS, READERS
 from mkdocs_table_reader_plugin.safe_eval import parse_argkwarg
-from mkdocs_table_reader_plugin.readers import READERS, MACROS
-from mkdocs_table_reader_plugin.markdown import fix_indentation, add_indentation, convert_to_md_table
 
 logger = get_plugin_logger("table-reader")
 
@@ -138,7 +138,7 @@ def on_page_markdown(self, markdown, page, config, files, **kwargs):
             # match group 0: to extract any leading whitespace
             # match group 1: to extract the arguments (positional and keywords)
             tag_pattern = re.compile(
-                r"( *)\{\{\s+%s\((.+)\)\s+\}\}" % reader, flags=re.IGNORECASE
+                r"( *)\{\{\s+%s\((.+)\)\s+\}\}" % reader, flags=re.IGNORECASE # noqa: UP031
             )
             matches = re.findall(tag_pattern, markdown)
 

mkdocs_table_reader_plugin/readers.py → src/mkdocs_table_reader_plugin/readers.py

@@ -1,13 +1,13 @@
-import pandas as pd
-import yaml
+import functools
+import logging
 import os
 from pathlib import Path
-import logging
 
-import functools
+import pandas as pd
+import yaml
 
-from mkdocs_table_reader_plugin.utils import kwargs_in_func, kwargs_not_in_func
 from mkdocs_table_reader_plugin.markdown import convert_to_md_table
+from mkdocs_table_reader_plugin.utils import kwargs_in_func, kwargs_not_in_func
 
 logger = logging.getLogger("mkdocs.plugins")
 
@@ -134,14 +134,14 @@ def read_excel(*args, **kwargs) -> str:
 @ParseArgs
 def pd_read_yaml(*args, **kwargs) -> str:
     json_kwargs = kwargs_in_func(kwargs, pd.json_normalize)
-    with open(args[0], "r") as f:
+    with open(args[0]) as f:
         df = pd.json_normalize(yaml.safe_load(f), **json_kwargs)
     return df
 
 @ParseArgs
 def read_yaml(*args, **kwargs) -> str:
     json_kwargs = kwargs_in_func(kwargs, pd.json_normalize)
-    with open(args[0], "r") as f:
+    with open(args[0]) as f:
         df = pd.json_normalize(yaml.safe_load(f), **json_kwargs)
 
     markdown_kwargs = kwargs_not_in_func(kwargs, pd.json_normalize)
@@ -170,7 +170,7 @@ def read_raw(*args, **kwargs) -> str:
     Returns:
         str: file contents
     """
-    with open(args[0], "r") as f:
+    with open(args[0]) as f:
         return f.read()
 
 

mkdocs_table_reader_plugin/safe_eval.py → src/mkdocs_table_reader_plugin/safe_eval.py

@@ -111,8 +111,7 @@ def parse_argkwarg(input_str: str):
         else:
             if len(kwargs) != 0:
                 raise AssertionError(
-                    "[table-reader-plugin] Make sure the python in your reader tag is correct: Positional arguments follow keyword arguments in '%s'"
-                    % input_str
+                    f"[table-reader-plugin] Make sure the python in your reader tag is correct: Positional arguments follow keyword arguments in '{input_str}'"
                 )
             args.append(literal_eval(i))