clld-markdown-plugin 0.5.0__tar.gz → 1.1.0__tar.gz

{clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info → clld_markdown_plugin-1.1.0}/PKG-INFO

@@ -1,25 +1,40 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: clld-markdown-plugin
-Version: 0.5.0
-Summary: Render CLDF markdown in clld apps.
-Home-page: https://github.com/clld/clld-markdown-plugin
-Author: Robert Forkel, Florian Matter
-Author-email: robert_forkel@eva.mpg.de, florianmatter@gmail.com
-Project-URL: Bug Tracker, https://github.com/clld/clld-markdown-plugin/issues
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
+Version: 1.1.0
+Summary: A clld plugin to render CLDF markdown in clld apps.
+Author-email: Robert Forkel <dlce.rdm@eva.mpg.de>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/clld/clld-markdown-plugin
+Keywords: web,pyramid,clld
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: clld>=7.0
+Requires-Dist: clldutils
+Requires-Dist: pycldf
+Requires-Dist: markdown
 Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
 Provides-Extra: test
-License-File: LICENSE
+Requires-Dist: pytest>=5; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: coverage>=4.2; extra == "test"
+Requires-Dist: webtest; extra == "test"
+Dynamic: license-file
 
 # clld-markdown-plugin
 

clld_markdown_plugin-1.1.0/pyproject.toml

@@ -0,0 +1,94 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "clld-markdown-plugin"
+version = "1.1.0"
+description = "A clld plugin to render CLDF markdown in clld apps."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Robert Forkel", email = "dlce.rdm@eva.mpg.de"}
+]
+keywords = ["web", "pyramid", "clld"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+]
+dependencies = [
+    "clld>=7.0",
+    "clldutils",
+    "pycldf",
+    "markdown",
+]
+
+[project.urls]
+Homepage = "https://github.com/clld/clld-markdown-plugin"
+
+[project.optional-dependencies]
+dev = [
+    "ruff",
+    "wheel",
+    "build",
+    "twine",
+]
+test = [
+    "pytest>=5",
+    "pytest-mock",
+    "pytest-cov",
+    "coverage>=4.2",
+    "webtest",
+]
+
+[tool.setuptools]
+zip-safe = false
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+line-length = 100
+exclude = [".tox"]
+
+[tool.ruff.lint]
+# E/F match default Flake8; D enables pydocstyle checks (since you ignored specific D rules)
+select = ["UP", "N", "C90", "PL", "E", "F", "D"]
+ignore = [
+    "D211",
+    "D213",
+]
+
+[tool.pytest.ini_options]
+minversion = "5.0"
+testpaths = ["tests"]
+addopts = ["--cov"]
+
+[tool.coverage.run]
+source = [
+    "clld_markdown_plugin",
+    "tests",
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.tox]
+requires = ["tox>=4.19"]
+env_list = ["py311", "py312", "py313", "py314", "py315"]
+skip_missing_interpreters = true
+
+[tool.tox.env_run_base]
+extras = ["test"]
+commands = [["pytest", { replace = "posargs", default = [], extend = true }]]

clld_markdown_plugin-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{clld_markdown_plugin-0.5.0 → clld_markdown_plugin-1.1.0}/src/clld_markdown_plugin/__init__.py

@@ -1,10 +1,12 @@
 """Top-level package for clld-markdown-plugin."""
-import typing
 import logging
+from collections.abc import Sequence, Callable
+from typing import Any
 
 from markdown import Markdown
 from markdown import markdown as base_markdown
 from pycldf.ext.markdown import CLDFMarkdownLink
+from clld.web.app import ClldRequest
 from clld.db.meta import DBSession
 from clld.db.models import common
 from clld.web.util.helpers import rendered_sentence
@@ -16,11 +18,12 @@ log = logging.getLogger(__name__)
 
 __author__ = "Robert Forkel, Florian Matter"
 __email__ = "robert_forkel@eva.mpg.de, florianmatter@gmail.com"
-__version__ = "0.5.0"
+__version__ = "1.1.0"
 __all__ = ['markdown', 'includeme']
 
 
-def settings(custom: typing.Optional[dict] = None) -> dict:
+def settings(custom: dict[str, Any] | None = None) -> dict[str, Any]:
+    """Get settings relevant for rendering CLDF Markdown."""
     def full_spec(spec):
         return spec if isinstance(spec, dict) else {
             'route': spec.__name__.split('.')[-1].lower() if spec else '', 'model': spec}
@@ -47,7 +50,7 @@ def settings(custom: typing.Optional[dict] = None) -> dict:
         "keep_link_labels": False,
     }
     custom = custom or {}
-    for key in res:
+    for key in res:  # noqa: PLC0206
         if key == 'model_map':
             for k, v in custom.get(key, {}).items():
                 res[key][k] = full_spec(v)
@@ -61,8 +64,7 @@ def settings(custom: typing.Optional[dict] = None) -> dict:
 
 
 def includeme(config):
-    """
-    Called when the plugin is included in a clld app via `config.include('clld_markdown_plugin')`.
+    """Call to include the plugin in a clld app `config.include('clld_markdown_plugin')`.
 
     Merges default and custom configuration for the plugin in the app's deployment settings under
     key 'clld_markdown_plugin'.
@@ -78,100 +80,107 @@ def includeme(config):
     return config
 
 
-def comma_and_list(entries, sep1=", ", sep2=" and "):
+def _comma_and_list(entries: Sequence[str], sep1: str = ", ", sep2: str = " and ") -> str:
     output = entries[0]
     for entry in entries[1:-1]:
         output += sep1 + entry
     return output + sep2 + entries[-1]
 
 
-def link_entity(req, objid, route, model, session, decorate=None, ids=None, **kwargs):
+def link_entity(  # noqa: PLR0917,PLR0913
+        req: ClldRequest,
+        objid: str | None,
+        route: str,
+        model: type,
+        session,
+        decorate: Callable[[str], str] | None = None,
+        ids: Sequence[str] | None = None,
+        **kwargs,
+) -> str:
+    """Render a CLDF Markdown link as HTML."""
     if objid == "__all__":
         if ids:
-            md_strs = [
+            return _comma_and_list([
                 link_entity(req, mid, route, model, session, decorate=decorate, **kwargs)
                 for mid in ids[0].split(",")
-            ]
-            return comma_and_list(md_strs)
+            ])
         raise NotImplementedError("Table not yet implemented")  # pragma: no cover
-    else:
-        try:
-            entity = session.query(model).filter(model.id == objid)[0]
-        except IndexError:
-            raise ValueError(objid)  # pragma: no cover
-        label = kwargs.pop("label", [None])[0]
-        anchor = kwargs.pop("_anchor", [None])[0]
-        url = req.route_url(route, id=objid, _anchor=anchor, **kwargs)
-        md_str = '<a class="{}" href="{}">{}</a>'.format(
-            model.__tablename__.capitalize(), url, label or entity.name)
-        return decorate(md_str) if decorate else md_str
-
-
-def render_ex(req, objid, table, session, ids=None, **kw):
+    try:
+        entity = session.query(model).filter(model.id == objid)[0]
+    except IndexError as e:
+        raise ValueError(objid) from e  # pragma: no cover
+    label = kwargs.pop("label", [None])[0] or entity.name
+    anchor = kwargs.pop("_anchor", [None])[0]
+    url = req.route_url(route, id=objid, _anchor=anchor, **kwargs)
+    md_str = f'<a class="{model.__tablename__.capitalize()}" href="{url}">{label}</a>'
+    return decorate(md_str) if decorate else md_str
+
+
+def render_ex(req: ClldRequest, objid: str, table: str, session, ids=None, **_) -> str:
+    """Render an IGT example."""
     if objid == "__all__":
         if ids:
             ex_strs = [
-                render_ex(req, mid, table, session, subexample=True) for mid in ids[0].split(",")
-            ]
+                render_ex(req, mid, table, session, subexample=True) for mid in ids[0].split(",")]
             return '\n\n'.join(ex_strs)
     return rendered_sentence(session.query(common.Sentence).filter(common.Sentence.id == objid)[0])
 
 
+def _repl(
+        ml: CLDFMarkdownLink,
+        settings_: dict,
+        req,
+        session,
+        source_ids):
+    def ref(src):  # pragma: no cover
+        if WITH_MARKDOWN:
+            return base_markdown(src.bibtex().text(markdown=True))
+        return src.bibtex().text()
+
+    table = ml.table_or_fname
+    if table in settings_['renderer_map'] and "as_link" not in ml.parsed_url_query:
+        return settings_['renderer_map'][table](
+            req, ml.objid, table, session or DBSession, **ml.parsed_url_query)
+    if table in settings_['model_map']:
+        decorate = settings_['model_map'][table].get("decorate", None)
+        kw = dict(ml.parsed_url_query.items())
+        if ml.label and settings_['keep_link_labels']:
+            kw.setdefault('label', [ml.label])
+        if table == 'Source':
+            if ml.objid != '__all__':
+                source_ids.add(ml.objid)
+            elif 'cited_only' in ml.parsed_url.query:
+                model = settings_['model_map'][table]["model"]
+                return HTML.ul(*[
+                    HTML.li(literal(ref(session.query(model).filter(model.id == sid)[0])))
+                    for sid in sorted(source_ids)])
+        return link_entity(
+            req,
+            ml.objid,
+            settings_['model_map'][table]["route"],
+            settings_['model_map'][table]["model"],
+            session or DBSession,
+            decorate=decorate,
+            **kw,
+        )
+    log.error("Can't handle [%s] (%s).", ml.objid, table)
+    return f"{table}:{ml.objid}"
+
+
 def markdown(req, s: str, session=None) -> str:
-    """
-    :param req:
-    :param s:
-    :param permalink:
-    :param session:
-    :return: `str` containing HTML formatting.
-    """
+    """:return: `str` containing HTML formatting."""
     if __name__ not in req.registry.settings:  # pragma: no cover
         raise KeyError(
-            '{} must be included in the app config to use the "markdown" function.'.format(
-                __name__))
-    settings = req.registry.settings[__name__]
+            f'{__name__} must be included in the app config to use the "markdown" function.')
+    settings_ = req.registry.settings[__name__]
     source_ids = set()
 
     def repl(ml):
-        def ref(src):  # pragma: no cover
-            if WITH_MARKDOWN:
-                return base_markdown(src.bibtex().text(markdown=True))
-            return src.bibtex().text()
-
         if ml.is_cldf_link:
             try:
-                table = ml.table_or_fname
-                if table in settings['renderer_map'] and "as_link" not in ml.parsed_url_query:
-                    return settings['renderer_map'][table](
-                        req, ml.objid, table, session or DBSession, **ml.parsed_url_query)
-                elif table in settings['model_map']:
-                    decorate = settings['model_map'][table].get("decorate", None)
-                    kw = {k: v for k, v in ml.parsed_url_query.items()}
-                    if ml.label and settings['keep_link_labels']:
-                        kw.setdefault('label', [ml.label])
-                    if table == 'Source':
-                        if ml.objid != '__all__':
-                            source_ids.add(ml.objid)
-                        elif 'cited_only' in ml.parsed_url.query:
-                            model = settings['model_map'][table]["model"]
-                            return HTML.ul(*[
-                                HTML.li(literal(ref(
-                                    (session or DBSession).query(model).filter(model.id == sid)[0]
-                                )))
-                                for sid in sorted(source_ids)])
-                    return link_entity(
-                        req,
-                        ml.objid,
-                        settings['model_map'][table]["route"],
-                        settings['model_map'][table]["model"],
-                        session or DBSession,
-                        decorate=decorate,
-                        **kw,
-                    )
-                log.error(f"Can't handle [{ml.objid}] ({table}).")
-                return f"{table}:{ml.objid}"
-            except:  # noqa: E722
+                return _repl(ml, settings_, req, session or DBSession, source_ids)
+            except:  # noqa: E722  # pylint: disable=W0702
                 return ml.label
         return ml
 
-    return Markdown(extensions=settings["extensions"]).convert(CLDFMarkdownLink.replace(s, repl))
+    return Markdown(extensions=settings_["extensions"]).convert(CLDFMarkdownLink.replace(s, repl))

{clld_markdown_plugin-0.5.0 → clld_markdown_plugin-1.1.0/src/clld_markdown_plugin.egg-info}/PKG-INFO

@@ -1,25 +1,40 @@
-Metadata-Version: 2.1
-Name: clld_markdown_plugin
-Version: 0.5.0
-Summary: Render CLDF markdown in clld apps.
-Home-page: https://github.com/clld/clld-markdown-plugin
-Author: Robert Forkel, Florian Matter
-Author-email: robert_forkel@eva.mpg.de, florianmatter@gmail.com
-Project-URL: Bug Tracker, https://github.com/clld/clld-markdown-plugin/issues
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
+Metadata-Version: 2.4
+Name: clld-markdown-plugin
+Version: 1.1.0
+Summary: A clld plugin to render CLDF markdown in clld apps.
+Author-email: Robert Forkel <dlce.rdm@eva.mpg.de>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/clld/clld-markdown-plugin
+Keywords: web,pyramid,clld
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: clld>=7.0
+Requires-Dist: clldutils
+Requires-Dist: pycldf
+Requires-Dist: markdown
 Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
 Provides-Extra: test
-License-File: LICENSE
+Requires-Dist: pytest>=5; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: coverage>=4.2; extra == "test"
+Requires-Dist: webtest; extra == "test"
+Dynamic: license-file
 
 # clld-markdown-plugin
 

{clld_markdown_plugin-0.5.0 → clld_markdown_plugin-1.1.0}/src/clld_markdown_plugin.egg-info/SOURCES.txt

@@ -1,8 +1,6 @@
 LICENSE
 README.md
 pyproject.toml
-setup.cfg
-setup.py
 src/clld_markdown_plugin/__init__.py
 src/clld_markdown_plugin.egg-info/PKG-INFO
 src/clld_markdown_plugin.egg-info/SOURCES.txt

{clld_markdown_plugin-0.5.0 → clld_markdown_plugin-1.1.0}/src/clld_markdown_plugin.egg-info/requires.txt

@@ -1,16 +1,17 @@
+clld>=7.0
 clldutils
 pycldf
-clld
 markdown
 
 [dev]
-flake8
-twine
+ruff
 wheel
 build
+twine
 
 [test]
-pytest
+pytest>=5
 pytest-mock
 pytest-cov
-tox
+coverage>=4.2
+webtest

clld_markdown_plugin-0.5.0/pyproject.toml

@@ -1,4 +0,0 @@
-[build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
-

clld_markdown_plugin-0.5.0/setup.cfg

@@ -1,81 +0,0 @@
-[metadata]
-version = 0.5.0
-author = Robert Forkel, Florian Matter
-author_email = robert_forkel@eva.mpg.de, florianmatter@gmail.com
-classifiers = 
-	Development Status :: 2 - Pre-Alpha
-	Intended Audience :: Science/Research
-	License :: OSI Approved :: Apache Software License
-	Natural Language :: English
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
-	Programming Language :: Python :: 3.10
-	Programming Language :: Python :: 3.11
-	Programming Language :: Python :: 3.12
-description = Render CLDF markdown in clld apps.
-long_description = file: README.md
-long_description_content_type = text/markdown
-name = clld_markdown_plugin
-project_urls = 
-	Bug Tracker = https://github.com/clld/clld-markdown-plugin/issues
-url = https://github.com/clld/clld-markdown-plugin
-
-[options]
-zip_safe = False
-include_package_data = True
-packages = find:
-package_dir = 
-	=src
-install_requires = 
-	clldutils
-	pycldf
-	clld
-	markdown
-
-[options.extras_require]
-dev = 
-	flake8
-	twine
-	wheel
-	build
-test = 
-	pytest
-	pytest-mock
-	pytest-cov
-	tox
-
-[options.packages.find]
-include = clld_markdown_plugin, clld_markdown_plugin.*
-where = src
-
-[flake8]
-max-line-length = 100
-extend-ignore = E203
-
-[tool:pytest]
-addopts = --cov
-testpaths = tests
-filterwarnings = 
-	ignore::sqlalchemy.exc.RemovedIn20Warning
-
-[coverage:run]
-source = 
-	clld_markdown_plugin
-
-[coverage:report]
-show_missing = true
-
-[tox:tox]
-envlist = py38, py39, py310, py311, py312
-isolated_build = true
-skip_missing_interpreter = true
-
-[testenv]
-deps = .[test]
-commands = pytest {posargs}
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

clld_markdown_plugin-0.5.0/setup.py

@@ -1,6 +0,0 @@
-#!/usr/bin/env python
-
-import setuptools
-
-if __name__ == "__main__":
-    setuptools.setup()