v1.2.0 (#55)

* Implicit read for markdown files

* Update README

* Raise error on bad file type

README.md

@@ -7,15 +7,16 @@ esparto
 [![codecov](https://codecov.io/gh/domvwt/esparto/branch/main/graph/badge.svg?token=35J8NZCUYC)](https://codecov.io/gh/domvwt/esparto)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=domvwt_esparto&metric=alert_status)](https://sonarcloud.io/dashboard?id=domvwt_esparto)
 
-## Introduction
 
+## Introduction
 `esparto` is a simple HTML and PDF document generator for Python.
 The library takes a fully Pythonic approach to defining documents,
 allowing iterative building and modification of the page and its contents.
-`esparto` is especially good at:
 
+
+### Example Use Cases
 * Automated MI reporting
-* Collating and sharing data visualisation
+* Collating and sharing data visualisations
 * ML model performance and evaluation documents
 * Designing simple web pages
 
@@ -26,7 +27,7 @@ allowing iterative building and modification of the page and its contents.
 * Output self-contained HTML and PDF files
 * Responsive layout from [Bootstrap](https://getbootstrap.com/)
 * No CSS or HTML required
-* Automatic conversion for:
+* Implicit conversion for:
     * Markdown
     * Images
     * Pandas DataFrames
@@ -48,7 +49,6 @@ pip install weasyprint
 
 
 ## Dependencies
-
 *   [python](https://python.org/) >= 3.6
 *   [jinja2](https://palletsprojects.com/p/jinja/)
 *   [markdown](https://python-markdown.github.io/)
@@ -76,7 +76,7 @@ page = es.Page(title="Research")
 
 # Add or update content
 # Keys are used as titles
-page["Introduction"]["Part One"]["Item A"] = "lorem ipsum"
+page["Introduction"]["Part One"]["Item A"] = "./text/content.md"
 page["Introduction"]["Part One"]["Item B"] = "./pictures/image1.jpg"
 
 # Add content without a title
@@ -119,7 +119,6 @@ page.save_pdf("my-page.pdf")
 
 
 ## Example Output
-
 Iris Report - [HTML](https://domvwt.github.io/esparto/examples/iris-report.html) |
 [PDF](https://domvwt.github.io/esparto/examples/iris-report.pdf)
 

esparto/__init__.py

@@ -34,7 +34,7 @@
 
 # Add or update content
 # Keys are used as titles
-page["Introduction"]["Part One"]["Item A"] = "lorem ipsum"
+page["Introduction"]["Part One"]["Item A"] = "./text/content.md"
 page["Introduction"]["Part One"]["Item B"] = "./pictures/image1.jpg"
 
 # Add content without a title
@@ -87,7 +87,7 @@
 
 __author__ = """Dominic Thorn"""
 __email__ = "[email protected]"
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 
 _MODULE_PATH: _Path = _Path(__file__).parent.absolute()
 

esparto/_adaptors.py

@@ -1,5 +1,6 @@
 from functools import singledispatch
 from mimetypes import guess_type
+from pathlib import Path
 
 from esparto import _INSTALLED_MODULES
 from esparto._content import (
@@ -22,7 +23,7 @@ def content_adaptor(content: Content) -> Content:
       content (Any): Any content to be added to the document.
 
     Returns:
-      Content: Approriately wrapped content.
+      Content: Appropriately wrapped content.
 
     """
     if not issubclass(type(content), Content):
@@ -32,13 +33,26 @@ def content_adaptor(content: Content) -> Content:
 
 @content_adaptor.register(str)
 def content_adaptor_core(content: str) -> Content:
-    """Convert markdown or image to Markdown or Image content."""
+    """Convert text or image to Markdown or Image content."""
     guess = guess_type(content)
-    if guess and "image" in str(guess[0]):
-        return Image(content)
+    if guess and isinstance(guess[0], str):
+        file_type = guess[0].split("/")[0]
+        if file_type == "image":
+            return Image(content)
+        elif file_type == "text":
+            content = Path(content).read_text()
+        else:
+            raise TypeError(f"{content}: {file_type}")
     return Markdown(content)
 
 
+@content_adaptor.register(Path)
+def content_adaptor_path(content: Path) -> Content:
+    """Convert text or image path to Markdown or Image content."""
+    content_str = str(content)
+    return content_adaptor_core(content_str)
+
+
 # Function only available if Pandas is installed.
 if "pandas" in _INSTALLED_MODULES:
     from pandas.core.frame import DataFrame  # type: ignore

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "esparto"
-version = "1.1.0"
+version = "1.2.0"
 description = "Simple HTML and PDF document generator for Python."
 authors = ["Dominic Thorn <[email protected]>"]
 license = "MIT"
@@ -54,6 +54,7 @@ kaleido = "^0.2.1,!=0.2.1.post1"
 sklearn = "^0.0"
 shap = "^0.39.0"
 zipp = "^3.4.1"
+types-Markdown = "^3.3.0"
 
 [tool.poetry.extras]
 extras = ["beautifulsoup4", "weasyprint"]

tests/conftest.py

@@ -37,6 +37,7 @@
 adaptor_list = [
     ("this is markdown", co.Markdown),
     (_irises_path, co.Image),
+    (Path(_irises_path), co.Image),
 ]
 
 if _EXTRAS:

tests/test_adaptors.py

@@ -1,9 +1,10 @@
 from inspect import getmembers, isfunction, signature
+from pathlib import Path, PosixPath
 
 import pytest
 
 import esparto._adaptors as ad
-from esparto._content import Content
+from esparto._content import Content, Markdown
 from tests.conftest import _EXTRAS, adaptor_list
 
 
@@ -20,6 +21,9 @@ def test_all_adaptors_covered(adaptor_list_fn):
     adaptor_types.remove(Content)  # Can't use abstract base class in a test
     if _EXTRAS:
         adaptor_types.remove(ad.BokehObject)  # Can't use abstract base class in a test
+    if PosixPath in test_classes:
+        test_classes.remove(PosixPath)
+        test_classes = adaptor_types | {Path}
     adaptor_types.remove(None)
     missing = adaptor_types.difference(test_classes)
     assert not missing, missing
@@ -31,6 +35,26 @@ def test_adaptor_text(input_, expected):
     assert isinstance(output, expected)
 
 
+def test_adapator_textfile(tmp_path):
+    d = tmp_path / "sub"
+    d.mkdir()
+    p = d / "hello.exe"
+    CONTENT = "# This is some Markdown content"
+    p.write_text(CONTENT)
+    with pytest.raises(TypeError):
+        ad.content_adaptor(Path(p))
+
+
+def test_adapator_bad_file(tmp_path):
+    d = tmp_path / "sub"
+    d.mkdir()
+    p = d / "hello.txt"
+    CONTENT = "# This is some Markdown content"
+    p.write_text(CONTENT)
+    assert ad.content_adaptor(Path(p)) == Markdown(CONTENT)
+    assert ad.content_adaptor(str(p)) == Markdown(CONTENT)
+
+
 def test_incorrect_content_rejected():
     class FakeClass:
         def __call__(self):

tox.ini

@@ -22,11 +22,10 @@ commands =
 
 [testenv:codequal]
 basepython = python
+allowlist_externals = mypy
 deps =
     black
     flake8
-    mypy
-    pytest # needed for type stubs
 commands =
     black --check esparto tests
     flake8 esparto tests