website-build-tools 0.1.0__tar.gz

website_build_tools-0.1.0/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+Copyright (c) 2025 Matthew Scroggs & other contributors to DefElement
+
+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.

website_build_tools-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.2
+Name: website-build-tools
+Version: 0.1.0
+Summary: tools for building websites, used by defelement.org and quadraturerules.org
+Author-email: Matthew Scroggs <defelement@mscroggs.co.uk>
+License: MIT License
+        Copyright (c) 2025 Matthew Scroggs & other contributors to DefElement
+        
+        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.
+        
+Project-URL: homepage, https://github.com/DefElement/website-build-tools
+Project-URL: repository, https://github.com/DefElement/website-build-tools
+Requires-Python: >=3.8.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyGithub
+Requires-Dist: pytz
+Requires-Dist: pyyaml
+Provides-Extra: style
+Requires-Dist: ruff; extra == "style"
+Requires-Dist: mypy; extra == "style"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: ci
+Requires-Dist: website-build-tools[style,test]; extra == "ci"
+
+# Website build tools
+This repo contains code for building encyclopedia websites that is used by
+[DefElement](https://defelement.org)
+and [the online encyclopedia of quadrature rules](https://quadraturerules.org).
+
+## Installing
+
+To install the latest release from PyPI, run:
+
+```bash
+pip install website-build-tools
+```
+
+To install the latest code from GitHub, run:
+
+```bash
+pip install git+https://github.com/DefElement/website-build-tools.git
+```
+

website_build_tools-0.1.0/README.md

@@ -0,0 +1,19 @@
+# Website build tools
+This repo contains code for building encyclopedia websites that is used by
+[DefElement](https://defelement.org)
+and [the online encyclopedia of quadrature rules](https://quadraturerules.org).
+
+## Installing
+
+To install the latest release from PyPI, run:
+
+```bash
+pip install website-build-tools
+```
+
+To install the latest code from GitHub, run:
+
+```bash
+pip install git+https://github.com/DefElement/website-build-tools.git
+```
+

website_build_tools-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "website-build-tools"
+version = "0.1.0"
+description = "tools for building websites, used by defelement.org and quadraturerules.org"
+readme = "README.md"
+requires-python = ">=3.8.0"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Matthew Scroggs", email = "defelement@mscroggs.co.uk" }
+]
+dependencies = ["PyGithub", "pytz", "pyyaml"]
+
+[project.urls]
+homepage = "https://github.com/DefElement/website-build-tools"
+repository = "https://github.com/DefElement/website-build-tools"
+
+[project.optional-dependencies]
+style = ["ruff", "mypy"]
+test = ["pytest"]
+ci = ["website-build-tools[style,test]"]
+
+[tool.ruff]
+line-length = 100
+indent-width = 4
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.mypy]
+ignore_missing_imports = true

website_build_tools-0.1.0/setup.cfg

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

website_build_tools-0.1.0/test/test_import.py

@@ -0,0 +1,2 @@
+def test_import():
+    import webtools  # noqa: F401

website_build_tools-0.1.0/test/test_markup.py

@@ -0,0 +1,9 @@
+"""Test markup."""
+
+from webtools.code_markup import code_highlight
+from webtools.markup import markup
+
+
+def test_code_highlight_cpp():
+    assert "#&lt;" in code_highlight("#<include>", "cpp")
+    assert "#&lt;" in markup("```cpp\n#<include>\n```\n")

website_build_tools-0.1.0/website_build_tools.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.2
+Name: website-build-tools
+Version: 0.1.0
+Summary: tools for building websites, used by defelement.org and quadraturerules.org
+Author-email: Matthew Scroggs <defelement@mscroggs.co.uk>
+License: MIT License
+        Copyright (c) 2025 Matthew Scroggs & other contributors to DefElement
+        
+        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.
+        
+Project-URL: homepage, https://github.com/DefElement/website-build-tools
+Project-URL: repository, https://github.com/DefElement/website-build-tools
+Requires-Python: >=3.8.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyGithub
+Requires-Dist: pytz
+Requires-Dist: pyyaml
+Provides-Extra: style
+Requires-Dist: ruff; extra == "style"
+Requires-Dist: mypy; extra == "style"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: ci
+Requires-Dist: website-build-tools[style,test]; extra == "ci"
+
+# Website build tools
+This repo contains code for building encyclopedia websites that is used by
+[DefElement](https://defelement.org)
+and [the online encyclopedia of quadrature rules](https://quadraturerules.org).
+
+## Installing
+
+To install the latest release from PyPI, run:
+
+```bash
+pip install website-build-tools
+```
+
+To install the latest code from GitHub, run:
+
+```bash
+pip install git+https://github.com/DefElement/website-build-tools.git
+```
+

website_build_tools-0.1.0/website_build_tools.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+pyproject.toml
+test/test_import.py
+test/test_markup.py
+website_build_tools.egg-info/PKG-INFO
+website_build_tools.egg-info/SOURCES.txt
+website_build_tools.egg-info/dependency_links.txt
+website_build_tools.egg-info/requires.txt
+website_build_tools.egg-info/top_level.txt
+webtools/__init__.py
+webtools/citations.py
+webtools/code_markup.py
+webtools/html.py
+webtools/markup.py
+webtools/py.typed
+webtools/settings.py
+webtools/tools.py

website_build_tools-0.1.0/website_build_tools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

website_build_tools-0.1.0/website_build_tools.egg-info/requires.txt

@@ -0,0 +1,13 @@
+PyGithub
+pytz
+pyyaml
+
+[ci]
+website-build-tools[style,test]
+
+[style]
+ruff
+mypy
+
+[test]
+pytest

website_build_tools-0.1.0/website_build_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+webtools

website_build_tools-0.1.0/webtools/__init__.py

@@ -0,0 +1 @@
+"""Website building tools."""

website_build_tools-0.1.0/webtools/citations.py

@@ -0,0 +1,150 @@
+"""Citations."""
+
+import re
+import typing
+
+from webtools.tools import comma_and_join
+
+
+def markup_authors(a: typing.Union[str, typing.List[str]]) -> str:
+    """Markup authors.
+
+    Args:
+        a: Authors
+
+    Returns:
+        Formatted list of authors
+    """
+    if isinstance(a, str):
+        return a
+    else:
+        return comma_and_join(a)
+
+
+def markup_citation(r: typing.Dict[str, typing.Any]) -> str:
+    """Markup citations.
+
+    Args:
+        r: Citation
+
+    Returns:
+        Formatted citation
+    """
+    out = ""
+    if "author" in r:
+        out += markup_authors(r["author"])
+    else:
+        out += "<i>(unknown author)</i>"
+    if out[-1] != ".":
+        out += "."
+    out += f" {r['title']}"
+    if "journal" in r:
+        out += f", <em>{r['journal']}</em>"
+        if "volume" in r:
+            out += f" {r['volume']}"
+            if "issue" in r:
+                out += f"({r['issue']})"
+        if "pagestart" in r and "pageend" in r:
+            out += f", {r['pagestart']}&ndash;{r['pageend']}"
+    elif "arxiv" in r:
+        out += f", ar&Chi;iv: <a href='https://arxiv.org/abs/{r['arxiv']}'>{r['arxiv']}</a>"
+    if "booktitle" in r:
+        out += f", in <em>{r['booktitle']}</em>"
+        if "editor" in r:
+            out += f" (eds: {markup_authors(r['editor'])})"
+    if "year" in r:
+        out += f", {r['year']}"
+    out += "."
+    if "doi" in r:
+        out += f" [DOI:&nbsp;<a href='https://doi.org/{r['doi']}'>{r['doi']}</a>]"
+    if "url" in r:
+        out += f" [<a href='{r['url']}'>{r['url'].split('://')[1]}</a>]"
+    return out
+
+
+def wrap_caps(txt: str) -> str:
+    """Wrap capitials in curly braces.
+
+    Args:
+        txt: Input string
+
+    Returns:
+        String with capitals wrapped in curly braces
+    """
+    out = ""
+    for word in txt.split():
+        if out != "":
+            out += " "
+        if re.match(r".[A-Z]", word) or (out != "" and re.match(r"[A-Z]", word)):
+            out += f"{{{word}}}"
+        else:
+            out += word
+    return out
+
+
+def html_to_tex(txt: str) -> str:
+    """Convert html to TeX.
+
+    Args:
+        txt: HTML
+
+    Returns:
+        TeX
+    """
+    txt = re.sub(r"&([A-Za-z])acute;", r"\\'\1", txt)
+    txt = re.sub(r"&([A-Za-z])grave;", r"\\`\1", txt)
+    txt = re.sub(r"&([A-Za-z])caron;", r"\\v{\1}", txt)
+    txt = re.sub(r"&([A-Za-z])uml;", r"\\\"\1", txt)
+    txt = re.sub(r"&([A-Za-z])cedil;", r"\\c{\1}", txt)
+    txt = re.sub(r"&([A-Za-z])circ;", r"\\^\1", txt)
+    txt = re.sub(r"&([A-Za-z])tilde;", r"\\~\1", txt)
+    txt = txt.replace("&oslash;", "{\\o}")
+    txt = txt.replace("&ndash;", "--")
+    txt = txt.replace("&mdash;", "---")
+    return txt
+
+
+def make_bibtex(id: str, r: typing.Dict[str, typing.Any]) -> str:
+    """Make BibTex.
+
+    Args:
+        id: Unique identifier
+        r: A citation
+
+    Returns:
+        The citation in BibTeX format
+    """
+    if "type" not in r:
+        r["type"] = "article"
+    out = f"@{r['type']}{{{id},\n"
+
+    # Author-type fields
+    for i, j in [("AUTHOR", "author"), ("EDITOR", "editor")]:
+        if j in r:
+            out += " " * (10 - len(i)) + f"{i} = {{"
+            if isinstance(r[j], str):
+                out += html_to_tex(r[j])
+            else:
+                out += " and ".join([html_to_tex(k) for k in r[j]])
+            out += "},\n"
+
+    # Fields with caps that need wrapping
+    for i, j in [("TITLE", "title"), ("BOOKTITLE", "booktitle")]:
+        if j in r:
+            out += " " * (10 - len(i)) + f"{i} = {{{wrap_caps(html_to_tex(r[j]))}}},\n"
+
+    # Text fields
+    for i, j in [("JOURNAL", "journal")]:
+        if j in r:
+            out += " " * (10 - len(i)) + f"{i} = {{{html_to_tex(r[j])}}},\n"
+
+    # Numerical fields
+    for i, j in [("VOLUME", "volume"), ("NUMBER", "issue"), ("YEAR", "year"), ("DOI", "doi")]:
+        if j in r:
+            out += " " * (10 - len(i)) + f"{i} = {{{r[j]}}},\n"
+
+    # Page numbers
+    if "pagestart" in r and "pageend" in r:
+        out += f"     PAGES = {{{{{r['pagestart']}--{r['pageend']}}}}},\n"
+    out += "}"
+    return out

website_build_tools-0.1.0/webtools/code_markup.py

@@ -0,0 +1,152 @@
+"""Highlighting for code snippets."""
+
+import re
+import typing
+
+
+def _highlight(txt: str, comment_start: str, keywords: typing.List[str]) -> str:
+    """General highlight function."""
+    out = []
+    for line in txt.split("\n"):
+        comment = ""
+        if comment_start in line:
+            lsp = line.split(comment_start, 1)
+            line = lsp[0]
+            comment = f"<span style='color:#FF8800'>{comment_start}{lsp[1]}</span>"
+
+        lsp = line.split('"')
+        line = lsp[0]
+
+        for i, j in enumerate(lsp[1:]):
+            if i % 2 == 0:
+                line += f"<span style='color:#DD2299'>\"{j}"
+            else:
+                line += f'"</span>{j}'
+
+        for keyword in keywords:
+            line = re.sub(
+                rf"(&nbsp;|^)({keyword})(&nbsp;|$)",
+                r"\1<span style='color:#FF8800'>\2</span>\3",
+                line,
+            )
+        out.append(line + comment)
+
+    return "<br />".join(out)
+
+
+def python_highlight(txt: str) -> str:
+    """Apply syntax highlighting to Python snippet.
+
+    Args:
+        txt: Python snippet
+
+    Returns:
+        Snippet with syntax highlighting
+    """
+    return _highlight(
+        txt,
+        "#",
+        [
+            "for",
+            "while",
+            "from",
+            "import",
+            "return",
+            "if",
+            "elif",
+            "else",
+            "def",
+            "in",
+            "global",
+            "assert",
+        ],
+    )
+
+
+def rust_highlight(txt: str) -> str:
+    """Apply syntax highlighting to Rust snippet.
+
+    Args:
+        txt: Python snippet
+
+    Returns:
+        Snippet with syntax highlighting
+    """
+    return _highlight(
+        txt,
+        "//",
+        [
+            "use",
+            "while",
+            "for",
+            "return",
+            "if",
+            "else",
+            "function",
+            "let",
+        ],
+    )
+
+
+def cpp_highlight(txt: str) -> str:
+    """Apply syntax highlighting to C++ snippet.
+
+    Args:
+        txt: Python snippet
+
+    Returns:
+        Snippet with syntax highlighting
+    """
+    return _highlight(
+        txt,
+        "//",
+        [
+            "#include",
+            "auto",
+            "using",
+            "for",
+            "if",
+            "else",
+            "function",
+            "while",
+        ],
+    )
+
+
+def bash_highlight(txt: str) -> str:
+    """Apply syntax highlighting to Bash snippet.
+
+    Args:
+        txt: Bash snippet
+
+    Returns:
+        Snippet with syntax highlighting
+    """
+    txt = re.sub(
+        r"(python3?(?:&nbsp;-m&nbsp;.+?)?&nbsp;)", r"<span style='color:#FF8800'>\1</span>", txt
+    )
+    for keyword in ["wget", "mkdir", "tar", "cd", "cmake", "make", "ls", "cargo"]:
+        txt = re.sub(
+            rf"(&nbsp;|^)({keyword})(&nbsp;|$)",
+            r"\1<span style='color:#FF8800'>\2</span>\3",
+            txt,
+        )
+    return "<br />".join(txt.split("\n"))
+
+
+def code_highlight(txt: str, lang: typing.Optional[str] = None):
+    for a, b in [
+        (" ", "&nbsp;"),
+        ("<", "&lt;"),
+        (">", "&gt;"),
+    ]:
+        txt = txt.replace(a, b)
+    if lang == "python":
+        return python_highlight(txt)
+    if lang == "rust":
+        return rust_highlight(txt)
+    if lang == "cpp":
+        return cpp_highlight(txt)
+    if lang == "bash":
+        return bash_highlight(txt)
+    return txt

website_build_tools-0.1.0/webtools/html.py

@@ -0,0 +1,33 @@
+"""HTML tools."""
+
+import os
+import typing
+
+from webtools import settings
+from webtools.markup import insert_dates
+
+
+def make_html_page(content: str, pagetitle: typing.Optional[str] = None) -> str:
+    """Make a HTML page.
+
+    Args:
+        content: Page content
+        pagetitle: Page title
+
+    Return:
+        Formatted HTML page
+    """
+    assert settings.template_path is not None
+    out = ""
+    with open(os.path.join(settings.template_path, "intro.html")) as f:
+        out += insert_dates(f.read())
+    if pagetitle is None:
+        out = out.replace("{{: pagetitle}}", "")
+        out = out.replace("{{pagetitle | }}", "")
+    else:
+        out = out.replace("{{: pagetitle}}", f": {pagetitle}")
+        out = out.replace("{{pagetitle | }}", f"{pagetitle} | ")
+    out += content
+    with open(os.path.join(settings.template_path, "outro.html")) as f:
+        out += insert_dates(f.read())
+    return out

website_build_tools-0.1.0/webtools/markup.py

@@ -0,0 +1,534 @@
+"""Markup."""
+
+import os
+import re
+import shlex
+import typing
+from github import Github
+import warnings
+from datetime import datetime
+from urllib.parse import quote_plus
+
+from webtools import settings
+from webtools.code_markup import code_highlight
+from webtools.tools import comma_and_join
+
+
+page_references: typing.List[str] = []
+
+
+def cap_first(txt: str) -> str:
+    """Captialise first letter.
+
+    Args:
+        txt: Input text
+
+    Returns:
+        text with capitalised first letter
+    """
+    return txt[:1].upper() + txt[1:]
+
+
+def heading(hx: str, content: str, style: typing.Optional[str] = None) -> str:
+    """Create heading.
+
+    Args:
+        hx: HTML tag
+        content: Heading content
+
+    Returns:
+        Heading with self reference
+    """
+    out = f"<{hx}"
+    if style is not None:
+        out += f' style="{style}"'
+    out += f">{content}</{hx}>\n"
+    return out
+
+
+def heading_with_self_ref(hx: str, content: str, style: typing.Optional[str] = None) -> str:
+    """Create heading with self reference.
+
+    Args:
+        hx: HTML tag
+        content: Heading content
+
+    Returns:
+        Heading with self reference
+    """
+    id = quote_plus(content)
+    out = f'<{hx} id="{id}"'
+    if style is not None:
+        out += f' style="{style}"'
+    out += f'><a href="#{id}">{content}</a></{hx}>\n'
+    return out
+
+
+def format_names(names: typing.List[str], format: str) -> str:
+    """Format names.
+
+    Args:
+        names: List of names
+        format: Format. `bibtex`, `html`, and `citation` are allowed
+
+    Returns:
+        Formatted names
+    """
+    if format == "bibtex":
+        return ("\n" + " " * 17 + "and ").join(names)
+    else:
+        formatted_names = []
+        for n in names:
+            if n == "et al":
+                formatted_names.append("et al")
+            else:
+                nsp = n.split(", ")
+                name = ""
+                for i in nsp[:0:-1]:
+                    for j in i.split(" "):
+                        name += f"{j[0]}. "
+                name += nsp[0]
+                formatted_names.append(name)
+        if names[-1] == "et al":
+            if len(formatted_names) <= 2:
+                return " ".join(formatted_names)
+            else:
+                return ", ".join([", ".join(formatted_names[:-1]), formatted_names[-1]])
+        else:
+            return comma_and_join(formatted_names)
+
+
+def person_sort_key(p: typing.Dict):
+    """Key used to sort people for the contributors and citation lists."""
+    if "github" in p:
+        if p["github"] in settings.owners:
+            return "AAA" + p["name"]
+        if p["github"] in settings.editors:
+            return "AAB" + p["name"]
+    return p["name"]
+
+
+def list_contributors(format: str = "html") -> str:
+    """Get list of contributors.
+
+    Args:
+        format: Format. `bibtex`, `html`, and `citation` are allowed
+
+    Returns:
+        Contributor list
+    """
+    if format not in ["html", "bibtex", "citation"]:
+        raise ValueError(f"Unsupported format: {format}")
+
+    people = settings.contributors
+    people.sort(key=person_sort_key)
+    editors = settings.editors
+
+    if format == "html":
+        included = []
+        out = ""
+
+        editors_out = ""
+        contributors_out = ""
+        for info in people:
+            person_out = ""
+            if "img" in info:
+                person_out += f"<img src='/img/people/{info['img']}' class='person'>"
+            person_out += heading_with_self_ref("h2", " ".join(info["name"].split(", ")[::-1]))
+            if "desc" in info:
+                person_out += f"<p>{markup(info['desc'])}</p>"
+            if "website" in info:
+                website_name = info["website"].split("//")[1].strip("/")
+                person_out += (
+                    f"<div class='social'><a href='{info['website']}'>"
+                    "<i class='fa-brands fa-internet-explorer' aria-hidden='true'></i>"
+                    f"&nbsp;{website_name}</a></div>"
+                )
+            if "email" in info:
+                person_out += (
+                    f"<div class='social'><a href='mailto:{info['email']}'>"
+                    "<i class='fa-regular fa-envelope' aria-hidden='true'></i>"
+                    f"&nbsp;{info['email']}</a></div>"
+                )
+            if "github" in info:
+                person_out += (
+                    f"<div class='social'><a href='https://github.com/{info['github']}'>"
+                    "<i class='fa-brands fa-github' aria-hidden='true'></i>"
+                    f"&nbsp;{info['github']}</a></div>"
+                )
+                included.append(info["github"])
+            if "twitter" in info:
+                person_out += (
+                    f"<div class='social'><a href='https://twitter.com/{info['twitter']}'>"
+                    "<i class='fa-brands fa-twitter' aria-hidden='true'></i>"
+                    f"&nbsp;@{info['twitter']}</a></div>"
+                )
+            if "bluesky" in info:
+                person_out += (
+                    f"<div class='social'><a href='https://bsky.app/profile/{info['bluesky']}'>"
+                    "<i class='fa-brands fa-bluesky' aria-hidden='true'></i>"
+                    f"&nbsp;@{info['bluesky']}</a></div>"
+                )
+            if "mastodon" in info:
+                handle, url = info["mastodon"].split("@")
+                person_out += (
+                    f"<div class='social'><a href='https://{url}/@{handle}'>"
+                    "<i class='fa-brands fa-mastodon' aria-hidden='true'></i>"
+                    f"&nbsp;@{handle}@{url}</a></div>"
+                )
+            person_out += "<br style='clear:both' />"
+            if "github" in info and info["github"] in editors:
+                editors_out += person_out
+            else:
+                contributors_out += person_out
+
+        if editors != "":
+            out += heading_with_self_ref("h1", "Editors", "margin-top:50px")
+            out += (
+                "<p>The contributors listed in this section are responsible for reviewing "
+                f"contributions to {settings.website_name[1]}.</p>\n{editors_out}"
+            )
+            if contributors_out != "":
+                out += heading_with_self_ref("h1", "Contributors", "margin-top:50px")
+        out += contributors_out
+
+        if settings.github_token is None or settings.repo is None:
+            warnings.warn("Building without GitHub token. Skipping search for GitHub contributors.")
+        else:
+            g = Github(settings.github_token)
+            repo = g.get_repo(settings.repo)
+            pages = repo.get_contributors()
+            i = 0
+            extras = []
+            while True:
+                page = pages.get_page(i)
+                if len(page) == 0:
+                    break
+                for user in page:
+                    if user.login not in included:
+                        extras.append((user.login, user.name))
+                i += 1
+            if len(extras) > 0:
+                out += heading_with_self_ref("h2", "Additional contributors")
+                out += (
+                    f"<p>The following people have contributed to {settings.website_name[1]}"
+                    " but are yet to add details about themselves to this page:</p>\n<ul>\n"
+                )
+                for u in extras:
+                    out += "<li>"
+                    if u[1] is not None:
+                        out += f"{u[1]} ("
+                    out += (
+                        f"<a href='https://github.com/{u[0]}'>"
+                        "<i class='fa-brands fa-github' aria-hidden='true'></i>"
+                        f"&nbsp;{u[0]}</a>"
+                    )
+                    if u[1] is not None:
+                        out += ")"
+                    out += "</li>\n"
+                out += "</ul>"
+                out += (
+                    "<p>If you're listed here, you can find instructions for how to add "
+                    "information about yourself on the [contributing page](contributing.md"
+                    "#Adding+yourself+to+the+contributors+list).</p>"
+                )
+
+        return out
+    else:
+        names = []
+        for info in people:
+            names.append(info["name"])
+
+        if settings.github_token is None or settings.repo is None:
+            warnings.warn("Building without GitHub token. Skipping search for GitHub contributors.")
+        else:
+            included = [info["github"] for info in people if "github" in info]
+            g = Github(settings.github_token)
+            repo = g.get_repo(settings.repo)
+            pages = repo.get_contributors()
+            i = 0
+            while True:
+                page = pages.get_page(i)
+                if len(page) == 0:
+                    break
+                for user in page:
+                    if user.login not in included:
+                        if format == "bibtex":
+                            names.append("others")
+                        else:
+                            names.append("et al")
+                        break
+                else:
+                    i += 1
+                    continue
+                break
+
+        return format_names(names, format)
+
+
+def preprocess(content: str) -> str:
+    """Preprocess content.
+
+    Args:
+        content: Content
+
+    Returns:
+        Preprocessed content
+    """
+    assert settings.dir_path is not None
+    for file in os.listdir(settings.dir_path):
+        if file.endswith(".md"):
+            if f"{{{{{file}}}}}" in content:
+                with open(os.path.join(settings.dir_path, file)) as f:
+                    content = content.replace(
+                        f"{{{{{file}}}}}", f.read().replace(f"]({settings.url}", "](")
+                    )
+
+    if "{{list contributors}}" in content:
+        content = content.replace("{{list contributors}}", list_contributors())
+    if "{{list contributors|" in content:
+        content = re.sub(
+            "{{list contributors\\|([^}]+)}}",
+            lambda matches: list_contributors(matches[1]),
+            content,
+        )
+    content = re.sub(r"{{author-info::([^}]+)}}", author_info, content)
+
+    return content
+
+
+def insert_links(txt: str, root_dir: str = "") -> str:
+    """Insert links.
+
+    Args:
+        txt: text
+
+    Returns:
+        Text with links
+    """
+    txt = re.sub(r"\(\/([^\)]+)\.md\)", r"(\1.html)", txt)
+    txt = re.sub(r"\(\/([^\)]+)\.md#([^\)]+)\)", r"(\1.html#\2)", txt)
+    if root_dir == "":
+        txt = re.sub(r"\(([^\)]+)\.md\)", r"(/\1.html)", txt)
+        txt = re.sub(r"\(([^\)]+)\.md#([^\)]+)\)", r"(/\1.html#\2)", txt)
+    else:
+        txt = re.sub(r"\(([^\)]+)\.md\)", rf"(/{root_dir}/\1.html)", txt)
+        txt = re.sub(r"\(([^\)]+)\.md#([^\)]+)\)", rf"(/{root_dir}/\1.html#\2)", txt)
+    txt = re.sub(r"\[([^\]]+)\]\(([^\)]+)\)", r"<a href='\2'>\1</a>", txt)
+    return txt
+
+
+def insert_dates(txt: str) -> str:
+    """Insert dates.
+
+    Args:
+        txt: Text
+
+    Returns:
+        Text with dates inserted
+    """
+    now = datetime.now()
+    txt = txt.replace("{{date:Y}}", now.strftime("%Y"))
+    txt = txt.replace("{{date:D-M-Y}}", now.strftime("%d-%B-%Y"))
+
+    return txt
+
+
+def markup(content: str, root_dir: str = "") -> str:
+    """Markup content.
+
+    Args:
+        content: Content
+
+    Returns:
+        Content with markup replaced by HTML
+    """
+    global page_references
+
+    content = preprocess(content)
+    content = content.replace("\\vec", "\\mathbf")
+
+    out = ""
+    popen = False
+    ulopen = False
+    liopen = False
+    code = False
+    lang: typing.Optional[str] = None
+
+    for line in content.split("\n"):
+        if line.startswith("```"):
+            code = not code
+            lang = line[3:].strip()
+        elif not code and line.startswith("#"):
+            if popen:
+                out += "</p>\n"
+                popen = False
+            if ulopen:
+                if liopen:
+                    out += "</li>"
+                    liopen = False
+                out += "</ul>\n"
+                ulopen = False
+            i = 0
+            while line.startswith("#"):
+                line = line[1:]
+                i += 1
+            out += heading_with_self_ref(f"h{i}", line.strip())
+        elif not code and line.startswith("* "):
+            if popen:
+                out += "</p>\n"
+                popen = False
+            if not ulopen:
+                out += "<ul>"
+                ulopen = True
+            if liopen:
+                out += "</li>"
+                liopen = False
+            out += "<li>"
+            liopen = True
+            out += line[2:].strip()
+        elif line == "":
+            if popen:
+                out += "</p>\n"
+                popen = False
+            if ulopen:
+                if liopen:
+                    out += "</li>"
+                    liopen = False
+                out += "</ul>\n"
+                ulopen = False
+        else:
+            if not ulopen and not popen and not line.startswith("<") and not line.startswith("\\["):
+                if code:
+                    out += "<p class='pcode'>"
+                else:
+                    out += "<p>"
+                popen = True
+            if code:
+                out += code_highlight(line, lang)
+                out += "<br />"
+            else:
+                out += line
+                out += " "
+
+    page_references = []
+
+    out = out.replace("(CODE_OF_CONDUCT.md)", "(code-of-conduct.md)")
+
+    out = re.sub(r" *<ref ([^>]+)>", add_citation, out)
+
+    if settings.insert_links is None:
+        out = insert_links(out, root_dir)
+    else:
+        out = settings.insert_links(out, root_dir)
+    out = re.sub(r"{{code-include::([^}]+)}}", code_include, out)
+
+    for a, b in settings.re_extras:
+        out = re.sub(a, b, out)
+    for c, d in settings.str_extras:
+        out = out.replace(c, d)
+
+    out = re.sub(r"`([^`]+)`", r"<span style='font-family:monospace'>\1</span>", out)
+
+    out = re.sub(r"\*\*([^\n]+)\*\*", r"<strong>\1</strong>", out)
+    out = re.sub(r"\*([^\n]+)\*", r"<em>\1</em>", out)
+
+    out = out.replace("{{tick}}", "<span style='color:#008800'>&#10004;</span>")
+
+    if len(page_references) > 0:
+        out += heading_with_self_ref("h2", "References")
+        out += "<ul class='citations'>"
+        out += "".join(
+            [
+                f"<li><a class='refid' id='ref{i + 1}'>[{i + 1}]</a> {j}</li>"
+                for i, j in enumerate(page_references)
+            ]
+        )
+        out += "</ul>"
+
+    return insert_dates(out)
+
+
+def code_include(matches: typing.Match[str]) -> str:
+    """Format code snippet.
+
+    Args:
+        matches: Code snippets
+
+    Returns:
+        HTML
+    """
+    assert settings.dir_path is not None
+    out = "<p class='pcode'>"
+    with open(os.path.join(settings.dir_path, matches[1])) as f:
+        out += "<br />".join(line.replace(" ", "&nbsp;") for line in f)
+    out += "</p>"
+    return out
+
+
+def to_tex(txt: str) -> str:
+    """Convert to TeX."""
+    for letter in "ABCDEFGHIJKLMNOPQRSTUVWXYZ":
+        txt = txt.replace(letter, f"{{{letter}}}")
+    return txt
+
+
+def author_info(matches: typing.Match[str]) -> str:
+    """Format author info.
+
+    Args:
+        matches: author info
+
+    Returns:
+        HTML
+    """
+    assert settings.website_name[0] is not None
+    authors, title, url = matches[1].split("|")
+    authors = authors.split(";")
+    out = "<div class='authors'>Written by "
+    out += " ".join(" ".join(i.split(", ")[::-1]) for i in authors)
+    out += (
+        "</div>\n"
+        "<a class='show_eg_link' href='javascript:show_author_cite_info()' id='showcitelink' "
+        "style='display:block'>&darr; Cite this page &darr;</a>"
+        "<div id='authorcite' style='display:none'>"
+        "<a class='show_eg_link' href='javascript:hide_author_cite_info()' id='showcitelink' "
+        "style='display:block'>&uarr; Hide citation info &uarr;</a>"
+        "You can cite this page using the following BibTeX:\n\n"
+        "```\n"
+        f"@misc{{{settings.website_name[0].lower()},\n"
+        f"       AUTHOR = {{{format_names(authors, 'bibtex')}}},\n"
+        f"        TITLE = {{{to_tex(settings.website_name[0])}: {title}}},\n"
+        "         YEAR = {{{{date:Y}}}},\n"
+        f" HOWPUBLISHED = {{\\url{{{settings.url}/{url}}}}},\n"
+        "         NOTE = {[Online; accessed {{date:D-M-Y}}]}\n"
+        "}\n"
+        "```\n\n"
+        "This will create a reference along the lines of:\n\n"
+        "<ul class='citations'>"
+        f"<li>{format_names(authors, 'citation')}. <i>{settings.website_name[0]}: {title}</i>, "
+        f"{{{{date:Y}}}}, <a href='{settings.url}/{url}'>{settings.url}/{url}</a> "
+        "[Online; accessed: {{date:D-M-Y}}]</li>\n"
+        "</ul></div>"
+    )
+    return out
+
+
+def add_citation(matches: typing.Match[str]) -> str:
+    """Add citation.
+
+    Args:
+        matches: Citation info
+
+    Returns:
+        HTML
+    """
+    global page_references
+    from webtools.citations import markup_citation
+
+    ref = {}
+    for i in shlex.split(matches[1]):
+        a, b = i.split("=")
+        ref[a] = b
+    page_references.append(markup_citation(ref))
+    return f"<sup><a href='#ref{len(page_references)}'>[{len(page_references)}]</a></sup>"

website_build_tools-0.1.0/webtools/settings.py

@@ -0,0 +1,19 @@
+"""Settings."""
+
+import typing as _typing
+
+dir_path: _typing.Optional[str] = None
+html_path: _typing.Optional[str] = None
+template_path: _typing.Optional[str] = None
+github_token: _typing.Optional[str] = None
+
+owners: _typing.List[str] = []
+editors: _typing.List[str] = []
+contributors: _typing.List[_typing.Dict[str, str]] = []
+url: _typing.Optional[str] = None
+website_name: _typing.List[_typing.Optional[str]] = [None, None]
+repo: _typing.Optional[str] = None
+
+re_extras: _typing.List[_typing.Tuple[str, _typing.Callable]] = []
+str_extras: _typing.List[_typing.Tuple[str, str]] = []
+insert_links: _typing.Optional[_typing.Callable] = None

website_build_tools-0.1.0/webtools/tools.py

@@ -0,0 +1,75 @@
+"""Tools."""
+
+import os
+import typing
+
+import yaml
+from webtools import settings
+
+
+def join(*folders):
+    """Join multiple folders with os.path.join."""
+    if len(folders) == 1:
+        return folders[0]
+
+    return join(os.path.join(*folders[:2]), *folders[2:])
+
+
+def parse_metadata(content: str) -> typing.Tuple[typing.Dict[str, typing.Any], str]:
+    """Parse metadata.
+
+    Args:
+        content: Raw data
+
+    Returns:
+        Parsed metadata and content without metadata
+    """
+    from webtools.markup import preprocess
+
+    metadata: typing.Dict[str, typing.Any] = {"title": None}
+    if content.startswith("--\n"):
+        metadata_in, content = content[3:].split("\n--\n", 1)
+        metadata.update(yaml.load(metadata_in, Loader=yaml.FullLoader))
+    content = preprocess(content.strip())
+    if metadata["title"] is None and content.startswith("# "):
+        metadata["title"] = content[2:].split("\n", 1)[0].strip()
+    return metadata, content
+
+
+def html_local(path: str) -> str:
+    """Get the local HTML path of a absolute path.
+
+    Args:
+        path: The absolute path
+
+    Returns:
+        Local HTML path
+    """
+    assert settings.html_path is not None
+    assert path.startswith(settings.html_path)
+    return path[len(settings.html_path) :]
+
+
+def comma_and_join(ls: typing.List[str], oxford_comma: bool = True) -> str:
+    """Join a list with commas and an and between the last two items."""
+    if len(ls) == 1:
+        return ls[0]
+    if len(ls) == 2:
+        return f"{ls[0]} and {ls[1]}"
+    return ", ".join(ls[:-1]) + ("," if oxford_comma else "") + " and " + ls[-1]
+
+
+def insert_author_info(content: str, authors: typing.List[str], url: str) -> str:
+    """Insert author info into content.
+
+    Args:
+        content: The content
+        authors: List of authors
+        url: A URL
+
+    Returns:
+        Content with authrso inserted
+    """
+    assert content.startswith("# ")
+    title, content = content.split("\n", 1)
+    return f"{title}\n{{{{author-info::{';'.join(authors)}|{title[1:].strip()}|{url}}}}}\n{content}"