clld-markdown-plugin 0.5.0__tar.gz

clld_markdown_plugin-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

clld_markdown_plugin-0.5.0/PKG-INFO

@@ -0,0 +1,81 @@
+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
+Classifier: Natural Language :: English
+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
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Provides-Extra: test
+License-File: LICENSE
+
+# clld-markdown-plugin
+
+Render [CLDF markdown](https://github.com/cldf/cldf/blob/master/extensions/markdown.md) in clld apps
+
+## Usage
+
+Include (and configure the plugin) in your app's `main` function:
+```python
+def main(global_config, **settings):
+    settings['clld_markdown_plugin'] = {
+        'model_map': {'ValueTable': common.ValueSet},
+        'function_map': {}
+    }
+    config = Configurator(settings=settings)
+    config.include('clld.web.app')
+    ...
+    config.include('clld_markdown_plugin')
+```
+
+Then you can use `clld_markdown_plugin.markup` as follows in your templates:
+```html
+<%! from clld_markdown_plugin import markdown %>
+
+${markdown(req, '[x](LanguageTable#cldf:abad1241)')|n}
+```
+
+By default, links to objects in the CLDF dataset will be rendered as HTML links to the corresponding
+object's details page in the clld app.
+
+
+### Configuration
+
+The plugin can be configured via the following four configuration options:
+
+- `model_map`: A `dict` mapping CLDF component names to DB model classes defined for the app. This
+  allows for a flexible mapping between CLDF components and the clld DB classes.
+- `renderer_map`: See below for details.
+- `extensions`: A list of [markdown extensions](https://python-markdown.github.io/extensions/#officially-supported-extensions)
+  in dot notation, to be activated when calling the `markdown` function.
+- `keep_link_labels`: A `boolean` indicating whether to keep link labels as they appear in the
+  CLDF Markdown text. By default (`False`), labels will be substituted using the linked object's
+  name.
+
+
+#### Renderer callables
+
+The `renderer_map` configuration option for `clld_markdown_plugin` accepts a `dict` mapping
+CLDF component names to Python callables with the following signature:
+
+```python
+import clld.web.app
+
+
+def renderer(req: clld.web.app.ClldRequest, objid: str, table, session: clld.db.meta.DBSession, ids=None) -> str:
+    """
+    The returned `str` is interpreted as Markdown, so it may also include HTML.
+    """
+```

clld_markdown_plugin-0.5.0/README.md

@@ -0,0 +1,58 @@
+# clld-markdown-plugin
+
+Render [CLDF markdown](https://github.com/cldf/cldf/blob/master/extensions/markdown.md) in clld apps
+
+## Usage
+
+Include (and configure the plugin) in your app's `main` function:
+```python
+def main(global_config, **settings):
+    settings['clld_markdown_plugin'] = {
+        'model_map': {'ValueTable': common.ValueSet},
+        'function_map': {}
+    }
+    config = Configurator(settings=settings)
+    config.include('clld.web.app')
+    ...
+    config.include('clld_markdown_plugin')
+```
+
+Then you can use `clld_markdown_plugin.markup` as follows in your templates:
+```html
+<%! from clld_markdown_plugin import markdown %>
+
+${markdown(req, '[x](LanguageTable#cldf:abad1241)')|n}
+```
+
+By default, links to objects in the CLDF dataset will be rendered as HTML links to the corresponding
+object's details page in the clld app.
+
+
+### Configuration
+
+The plugin can be configured via the following four configuration options:
+
+- `model_map`: A `dict` mapping CLDF component names to DB model classes defined for the app. This
+  allows for a flexible mapping between CLDF components and the clld DB classes.
+- `renderer_map`: See below for details.
+- `extensions`: A list of [markdown extensions](https://python-markdown.github.io/extensions/#officially-supported-extensions)
+  in dot notation, to be activated when calling the `markdown` function.
+- `keep_link_labels`: A `boolean` indicating whether to keep link labels as they appear in the
+  CLDF Markdown text. By default (`False`), labels will be substituted using the linked object's
+  name.
+
+
+#### Renderer callables
+
+The `renderer_map` configuration option for `clld_markdown_plugin` accepts a `dict` mapping
+CLDF component names to Python callables with the following signature:
+
+```python
+import clld.web.app
+
+
+def renderer(req: clld.web.app.ClldRequest, objid: str, table, session: clld.db.meta.DBSession, ids=None) -> str:
+    """
+    The returned `str` is interpreted as Markdown, so it may also include HTML.
+    """
+```

clld_markdown_plugin-0.5.0/pyproject.toml

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

clld_markdown_plugin-0.5.0/setup.cfg

@@ -0,0 +1,81 @@
+[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

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

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin/__init__.py

@@ -0,0 +1,177 @@
+"""Top-level package for clld-markdown-plugin."""
+import typing
+import logging
+
+from markdown import Markdown
+from markdown import markdown as base_markdown
+from pycldf.ext.markdown import CLDFMarkdownLink
+from clld.db.meta import DBSession
+from clld.db.models import common
+from clld.web.util.helpers import rendered_sentence
+from clld.web.util.htmllib import HTML, literal
+import clldutils
+
+WITH_MARKDOWN = tuple(map(int, clldutils.__version__.split('.')[:2])) >= (3, 21)
+log = logging.getLogger(__name__)
+
+__author__ = "Robert Forkel, Florian Matter"
+__email__ = "robert_forkel@eva.mpg.de, florianmatter@gmail.com"
+__version__ = "0.5.0"
+__all__ = ['markdown', 'includeme']
+
+
+def settings(custom: typing.Optional[dict] = None) -> dict:
+    def full_spec(spec):
+        return spec if isinstance(spec, dict) else {
+            'route': spec.__name__.split('.')[-1].lower() if spec else '', 'model': spec}
+
+    res = {
+        'model_map': {
+            "LanguageTable": full_spec(common.Language),
+            "ParameterTable": full_spec(common.Parameter),
+            "ValueTable": full_spec(common.Value),
+            "FormTable": full_spec(common.Unit),
+            "ExampleTable": full_spec(common.Sentence),
+            "ContributionTable": full_spec(common.Contribution),
+            "CognatesetTable": full_spec(common.UnitParameter),
+            "sources.bib": full_spec(common.Source),
+            "Source": full_spec(common.Source),
+        },
+        'renderer_map': {
+            "ExampleTable": render_ex,
+        },
+        "extensions": [
+            "markdown.extensions.fenced_code",
+            "markdown.extensions.tables",
+        ],
+        "keep_link_labels": False,
+    }
+    custom = custom or {}
+    for key in res:
+        if key == 'model_map':
+            for k, v in custom.get(key, {}).items():
+                res[key][k] = full_spec(v)
+        elif key == "renderer_map":
+            res[key].update(custom.get(key, {}))
+        elif key == "extensions":
+            res[key].extend(custom.get(key, []))
+        elif key in custom:
+            res[key] = custom[key]
+    return res
+
+
+def includeme(config):
+    """
+    Called when the plugin is included in a clld app via `config.include('clld_markdown_plugin')`.
+
+    Merges default and custom configuration for the plugin in the app's deployment settings under
+    key 'clld_markdown_plugin'.
+
+    .. seealso:: https://docs.pylonsproject.org/projects/pyramid/en/latest/api/registry.html\
+    #pyramid.registry.Registry.settings
+
+    :param config: `pyramid.config.Configurator`
+    :return: `pyramid.config.Configurator` with updated settings for `clld_markdown_plugin`.
+    """
+    config.registry.settings[__name__] = settings(
+        config.registry.settings.get(__name__))
+    return config
+
+
+def comma_and_list(entries, sep1=", ", sep2=" and "):
+    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):
+    if objid == "__all__":
+        if ids:
+            md_strs = [
+                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):
+    if objid == "__all__":
+        if ids:
+            ex_strs = [
+                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 markdown(req, s: str, session=None) -> str:
+    """
+    :param req:
+    :param s:
+    :param permalink:
+    :param session:
+    :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__]
+    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 ml.label
+        return ml
+
+    return Markdown(extensions=settings["extensions"]).convert(CLDFMarkdownLink.replace(s, repl))

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+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
+Classifier: Natural Language :: English
+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
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Provides-Extra: test
+License-File: LICENSE
+
+# clld-markdown-plugin
+
+Render [CLDF markdown](https://github.com/cldf/cldf/blob/master/extensions/markdown.md) in clld apps
+
+## Usage
+
+Include (and configure the plugin) in your app's `main` function:
+```python
+def main(global_config, **settings):
+    settings['clld_markdown_plugin'] = {
+        'model_map': {'ValueTable': common.ValueSet},
+        'function_map': {}
+    }
+    config = Configurator(settings=settings)
+    config.include('clld.web.app')
+    ...
+    config.include('clld_markdown_plugin')
+```
+
+Then you can use `clld_markdown_plugin.markup` as follows in your templates:
+```html
+<%! from clld_markdown_plugin import markdown %>
+
+${markdown(req, '[x](LanguageTable#cldf:abad1241)')|n}
+```
+
+By default, links to objects in the CLDF dataset will be rendered as HTML links to the corresponding
+object's details page in the clld app.
+
+
+### Configuration
+
+The plugin can be configured via the following four configuration options:
+
+- `model_map`: A `dict` mapping CLDF component names to DB model classes defined for the app. This
+  allows for a flexible mapping between CLDF components and the clld DB classes.
+- `renderer_map`: See below for details.
+- `extensions`: A list of [markdown extensions](https://python-markdown.github.io/extensions/#officially-supported-extensions)
+  in dot notation, to be activated when calling the `markdown` function.
+- `keep_link_labels`: A `boolean` indicating whether to keep link labels as they appear in the
+  CLDF Markdown text. By default (`False`), labels will be substituted using the linked object's
+  name.
+
+
+#### Renderer callables
+
+The `renderer_map` configuration option for `clld_markdown_plugin` accepts a `dict` mapping
+CLDF component names to Python callables with the following signature:
+
+```python
+import clld.web.app
+
+
+def renderer(req: clld.web.app.ClldRequest, objid: str, table, session: clld.db.meta.DBSession, ids=None) -> str:
+    """
+    The returned `str` is interpreted as Markdown, so it may also include HTML.
+    """
+```

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+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
+src/clld_markdown_plugin.egg-info/dependency_links.txt
+src/clld_markdown_plugin.egg-info/not-zip-safe
+src/clld_markdown_plugin.egg-info/requires.txt
+src/clld_markdown_plugin.egg-info/top_level.txt
+tests/test_unit.py

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info/requires.txt

@@ -0,0 +1,16 @@
+clldutils
+pycldf
+clld
+markdown
+
+[dev]
+flake8
+twine
+wheel
+build
+
+[test]
+pytest
+pytest-mock
+pytest-cov
+tox

clld_markdown_plugin-0.5.0/src/clld_markdown_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+clld_markdown_plugin

clld_markdown_plugin-0.5.0/tests/test_unit.py

@@ -0,0 +1,38 @@
+import pytest
+
+from clld_markdown_plugin import *
+
+
+@pytest.mark.parametrize(
+    'model_map,renderer_map,md,substring,notsubstring',
+    [
+        (dict(LanguageTable=None), {}, '[xyz](LanguageTable#cldf:l1)', 'xyz', None),
+        ({}, {}, '[xyz](LanguageTable#cldf:l1)', 'The Language', None),
+        ({}, {}, '[xyz](LanguageTable?_anchor=abc#cldf:l1)', '#abc', None),
+        ({}, {}, '[xyz](LanguageTable?ids=l1,l2,l3#cldf:__all__)', ' and ', None),
+        ({}, {}, '[xyz](ExampleTable#cldf:s1)', 'A sentence', None),
+        ({}, {}, '[xyz](ExampleTable?as_link#cldf:s1)', 'href=', None),
+        ({}, {}, '[xyz](ExampleTable?ids=s1#cldf:__all__)', '', None),
+        ({}, {}, '[xyz](NopeTable#cldf:1)', 'NopeTable', None),
+        (
+            {},
+            {},
+            '[](Source#cldf:Meier2012)\n[](Source?cited_only#cldf:__all__)',
+            'Meier',
+            'Mueller'),
+        ({}, {}, '[xyz](http://example.org)', 'http://example.org', None),
+    ]
+)
+def test_markdown(model_map, renderer_map, md, substring, notsubstring, dbsession, req_factory):
+    res = markdown(
+        req_factory(dict(model_map=model_map, renderer_map=renderer_map)), md, session=dbsession)
+    assert substring in res
+    if notsubstring:
+        assert notsubstring not in res
+
+
+def test_markdown_keep_labels(dbsession, req_factory):
+    res = markdown(req_factory(), '[xyz](LanguageTable#cldf:l1)')
+    assert 'xyz' not in res
+    res = markdown(req_factory(dict(keep_link_labels=True)), '[xyz](LanguageTable#cldf:l1)')
+    assert 'xyz' in res