teachbooks 0.0.1__tar.gz

teachbooks-0.0.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: teachbooks
+Version: 0.0.1
+Summary: TU Delft CiTG Jupyter Book Software Stack
+Author-email: Caspar Jungbacker <c.a.a.jungbacker@tudelft.nl>
+Project-URL: Homepage, https://gitlab.tudelft.nl/interactivetextbooks-citg/extensions/teachbooks-package
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: jupyter-book~=1.0
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: pandas
+
+# TeachBooks Package
+
+The TeachBooks package contains tools to make life easier when working with (interactive) Jupyter Books. It is essentially a wrapper around Jupyter Book.
+
+Work in progress...

teachbooks-0.0.1/README.md

@@ -0,0 +1,5 @@
+# TeachBooks Package
+
+The TeachBooks package contains tools to make life easier when working with (interactive) Jupyter Books. It is essentially a wrapper around Jupyter Book.
+
+Work in progress...

teachbooks-0.0.1/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "teachbooks"
+version = "0.0.1"
+description = "TU Delft CiTG Jupyter Book Software Stack"
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+  {name = "Caspar Jungbacker", email = "c.a.a.jungbacker@tudelft.nl"}
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+]
+dependencies = [
+  "jupyter-book ~= 1.0",
+  "numpy",
+  "matplotlib",
+  "scipy",
+  "pandas"
+]
+
+[project.scripts]
+teachbooks = "teachbooks.cli.main:main"
+
+[tool.setuptools.packages]
+find = {}
+
+[project.urls]
+"Homepage" = "https://gitlab.tudelft.nl/interactivetextbooks-citg/extensions/teachbooks-package"
+
+[project.entry-points."pybtex.style.formatting"]
+apa = "teachbooks.plugins.pybtex.formatting.apa:APAStyle"
+
+[project.entry-points."pybtex.style.labels"]
+apa = "teachbooks.plugins.pybtex.labels.apa:APALabelStyle"
+
+[project.entry-points."pybtex.style.names"]
+firstlast = "teachbooks.plugins.pybtex.names:FirstLastStyle"
+
+[project.entry-points."sphinxcontrib.bibtex.style.referencing"]
+author_year_round = "teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa:AuthorYearRoundReferenceStyle"

teachbooks-0.0.1/setup.cfg

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

teachbooks-0.0.1/teachbooks/cli/main.py

@@ -0,0 +1,53 @@
+import click
+
+from pathlib import Path
+from jupyter_book.cli.main import build as jupyter_book_build
+
+from teachbooks.publish import make_publish
+
+@click.group()
+def main():
+    """TeachBooks command line tools"""
+    pass
+
+@main.command()
+@click.argument("path-source", type=click.Path(exists=True, file_okay=True))
+@click.option(
+    "--publish",
+    is_flag=True,
+    help="Target publish version of the book. Removes any sections surrounded "
+    "by REMOVE-FROM-PUBLISH tags from _config.yml and _toc.yml"
+)
+@click.option(
+    "--process-only",
+    is_flag=True,
+    help="Only pre-process content, do not build the book"
+)
+@click.pass_context
+def build(ctx, path_source, publish, process_only):
+    """Pre-process book contents and run the Jupyter Book build command"""
+
+    strategy = "publish" if publish else "draft"
+    echo_info(f"running build with strategy '{strategy}'")
+
+    path_src_folder = Path(path_source).absolute()
+    if publish:
+        path_conf, path_toc = make_publish(path_src_folder)
+    else:
+        path_conf, path_toc = None, None
+
+    # Use default arguments for jb build, as we normally do
+    if not process_only:
+        ctx.invoke(
+            jupyter_book_build,
+            path_source=path_src_folder,
+            config=path_conf,
+            toc=path_toc
+        )
+
+
+def echo_info(message: str) -> None:
+    """Wrapper for writing to stdout"""
+    prefix = click.style("TeachBooks: ", fg="cyan", bold=True)
+    click.echo(prefix + message)
+    

teachbooks-0.0.1/teachbooks/plugins/pybtex/formatting/apa.py

@@ -0,0 +1,486 @@
+# -*- coding:Utf-8 -*-
+from __future__ import unicode_literals
+
+import re
+import six
+
+from pybtex.plugin import find_plugin
+from pybtex.style.formatting import BaseStyle, toplevel
+from pybtex.style.template import (
+    field, first_of, href, join, optional, optional_field, sentence, tag,
+    together, words, node, FieldIsMissing
+)
+
+from pybtex.richtext import Text, Symbol
+
+
+firstlast = find_plugin('pybtex.style.names', 'lastfirst')()
+
+if six.PY2:
+    def format_pages(text):
+        dash_re = re.compile(r'-+')
+        pages = Text(Symbol('ndash')).join(
+            re.split(dash_re, six.text_type(text)))
+        if re.search('[-‒–—―]', six.text_type(text)):
+            return Text("pp.", Symbol('nbsp'), pages)
+        return Text("p.", Symbol('nbsp'), pages)
+else:
+    def format_pages(text):
+        dash_re = re.compile(r'-+')
+        pages = Text(Symbol('ndash')).join(text.split(dash_re))
+        if re.search('[-‒–—―]', str(text)):
+            return Text("pp.", Symbol('nbsp'), pages)
+        return Text("p.", Symbol('nbsp'), pages)
+
+
+pages = field('pages', apply_func=format_pages)
+date = words[field('year'), optional[", ", field('month')]]
+
+
+@node
+def apa_names(children, context, role, **kwargs):
+    """
+    Returns formatted names as an APA compliant reference list citation.
+    """
+    assert not children
+
+    try:
+        persons = context['entry'].persons[role]
+    except KeyError:
+        raise FieldIsMissing(role, context['entry'])
+
+    style = context['style']
+
+    if len(persons) > 7:
+        persons = persons[:6] + persons[-1:]
+        formatted_names = [style.format_name(
+            person, style.abbreviate_names) for person in persons]
+        return join(sep=', ', last_sep=', … ')[
+            formatted_names].format_data(context)
+    else:
+        formatted_names = [style.format_name(
+            person, style.abbreviate_names) for person in persons]
+        return join(sep=', ', sep2=', & ', last_sep=', & ')[
+            formatted_names].format_data(context)
+
+
+@node
+def editor_names(children, context, with_suffix=True, **kwargs):
+    """
+    Returns formatted editor names for inbook.
+    """
+    assert not children
+
+    try:
+        editors = context['entry'].persons['editor']
+    except KeyError:
+        raise FieldIsMissing('editor', context['entry'])
+
+    formatted_names = [
+        firstlast.format(editor, True) for editor in editors]
+
+    if with_suffix:
+        return words[
+            join(sep=', ', sep2=', & ', last_sep=', & ')[formatted_names],
+            "(Eds.)" if len(editors) > 1 else "(Ed.)"
+        ].format_data(context)
+
+    return join(sep=', ', sep2=', & ', last_sep=', & ')[
+        formatted_names
+    ].format_data(context)
+
+
+class APAStyle(BaseStyle):
+    name = 'apa'
+    default_name_style = 'lastfirst'
+    default_sorting_style = 'author_year_title'
+    default_label_style = 'apa'
+
+    def __init__(self, *args, **kwargs):
+        super(APAStyle, self).__init__(*args, **kwargs)
+        self.abbreviate_names = True
+
+    def format_names(self, role, as_sentence=True):
+        formatted_names = apa_names(role)
+        if as_sentence:
+            return sentence(capfirst=False)[formatted_names]
+        else:
+            return formatted_names
+
+    def format_author_or_editor_and_date(self, e):
+        if 'author' in e.persons and 'editor' in e.persons:
+            return sentence(sep=' ')[
+                self.format_names('author'), join["(", date, ")."],
+                self.format_editor(e, as_sentence=False)]
+        elif 'author' in e.persons:
+            return sentence(sep=' ')[
+                self.format_names('author'), join["(", date, ")"]]
+        else:
+            return sentence(sep=' ')[
+                self.format_editor(e, as_sentence=False),
+                join["(", date, ")"]]
+
+    def format_editor(self, e, as_sentence=True):
+        editors = self.format_names('editor', as_sentence=False)
+        if 'editor' not in e.persons:
+            # when parsing the template, a FieldIsMissing exception
+            # will be thrown anyway; no need to do anything now,
+            # just return the template that will throw the exception
+            return editors
+        if len(e.persons['editor']) > 1:
+            word = '(Eds.)'
+        else:
+            word = '(Ed.)'
+        result = join(sep=' ')[editors, word]
+        if as_sentence:
+            return sentence[result]
+        else:
+            return result
+
+    def format_volume(self, e, for_article=False):
+        prefix = "Vol."
+        if for_article:
+            return join[
+                tag('em')[field('volume')],
+                optional['(', field('number'), ')'],
+            ]
+        else:
+            return optional[together[prefix, field('volume')]]
+
+    def format_title(self, e, which_field, as_sentence=True):
+        formatted_title = field(
+            which_field, apply_func=lambda text: text.capitalize()
+        )
+        if as_sentence:
+            return sentence[formatted_title]
+        else:
+            return formatted_title
+
+    def format_btitle(self, e, which_field, as_sentence=True):
+        formatted_title = tag('em')[field(which_field)]
+        if as_sentence:
+            return sentence[formatted_title]
+        else:
+            return formatted_title
+
+    def format_web_refs(self, e):
+        # Based on urlbst output.web.refs
+        return sentence(add_period=False)[
+            optional[self.format_url(e)],
+            optional[self.format_eprint(e)],
+            optional[self.format_pubmed(e)],
+            optional[self.format_doi(e)],
+        ]
+
+    def format_url(self, e):
+        # Based on urlbst format.url
+        return words[
+            'URL:',
+            href[
+                field('url', raw=True),
+                field('url', raw=True)
+            ]
+        ]
+
+    def format_pubmed(self, e):
+        # Based on urlbst format.pubmed
+        return href[
+            join[
+                'https://www.ncbi.nlm.nih.gov/pubmed/',
+                field('pubmed', raw=True)
+            ],
+            join[
+                'PMID:',
+                field('pubmed', raw=True)
+            ]
+        ]
+
+    def format_doi(self, e):
+        # Based on urlbst format.doi
+        return href[
+            join[
+                'https://doi.org/',
+                field('doi', raw=True)
+            ],
+            join[
+                'doi:',
+                field('doi', raw=True)
+            ]
+        ]
+
+    def format_eprint(self, e):
+        # Based on urlbst format.eprint
+        return href[
+            join[
+                'https://arxiv.org/abs/',
+                field('eprint', raw=True)
+            ],
+            join[
+                'arXiv:',
+                field('eprint', raw=True)
+            ]
+        ]
+
+    def get_article_template(self, e):
+        # Required fields: author, title, journal, year
+        # Optional fields: volume, number, pages, month, note, key
+        volume_and_pages = first_of[
+            # Volume and pages, with optional issue number
+            optional[
+                join[
+                    self.format_volume(e, for_article=True),
+                    optional[', ', field('pages')]
+                ],
+            ],
+            # Pages only
+            pages,
+        ]
+        template = toplevel[
+            self.format_names('author'),
+            sentence[
+                join["(", date, ")"]
+            ],
+            self.format_title(e, 'title'),
+            sentence[
+                tag('em')[field('journal')],
+                optional[volume_and_pages],
+            ],
+            sentence[optional_field('note')],
+            self.format_web_refs(e),
+        ]
+        return template
+
+    def get_book_template(self, e):
+        # Required fields: author/editor, title, publisher, year
+        # Optional fields: volume, series, address, edition, month, note, key,
+        #                  isbn
+        return toplevel[
+            self.format_author_or_editor_and_date(e),
+            sentence(sep=' ')[
+                self.format_btitle(e, 'title'),
+                optional[
+                    sentence[
+                        optional[field('edition'), ' ed.'],
+                        self.format_volume(e),
+                    ]
+                ]
+            ],
+            sentence(sep=': ')[
+                optional_field('address'),
+                field('publisher'),
+            ],
+            sentence[optional_field('note')],
+        ]
+
+    def get_booklet_template(self, e):
+        # Required fields: title
+        # Optional fields: author, howpublished, address, month, year, note,
+        #                  key
+        return toplevel[
+            sentence(sep=' ')[
+                first_of[
+                    optional[self.format_names(
+                        'author', as_sentence=False)],
+                    "None to claim their bones"
+                ],
+                join["(", first_of[optional[date], "n.d."], ")"]
+            ],
+            self.format_title(e, 'title'),
+            sentence[optional_field('address')],
+            sentence[optional_field('note')],
+        ]
+
+    def get_inbook_template(self, e):
+        # Required fields: author/editor, title, chapter/pages, publisher, year
+        # Optional fields: volume, series, address, edition, month, note, key
+        return toplevel[
+            sentence(sep=' ')[
+                self.format_names('author'),
+                join["(", date, ")"]
+            ],
+            self.format_title(e, 'title'),
+            sentence(sep=' ')[
+                optional[
+                    "In ",
+                    editor_names(),
+                    ","
+                ],
+                self.format_btitle(e, 'booktitle', as_sentence=False),
+                optional[
+                    join[
+                        "(",
+                        sentence(add_period=False)[
+                            optional[field('edition'), ' ed.'],
+                            self.format_volume(e),
+                            pages,
+                        ],
+                        ")"
+                    ]
+                ]
+            ],
+            sentence(sep=': ')[
+                optional_field('address'),
+                field('publisher'),
+            ],
+            sentence[optional_field('note')],
+        ]
+
+    def get_incollection_template(self, e):
+        # Required fields: author, title, booktitle, year
+        # Optional fields: editor, pages, organization, publisher, address,
+        #                  month, note, key
+        return toplevel[
+            self.format_author_or_editor_and_date(e),
+            self.format_title(e, 'title'),
+            sentence(sep=' ')[
+                self.format_btitle(e, 'booktitle', as_sentence=False),
+                optional["(", pages, ")"]
+            ],
+            sentence(sep=': ')[
+                optional_field('address'),
+                optional_field('publisher'),
+            ],
+            sentence[optional_field('note')],
+        ]
+
+    def get_inproceedings_template(self, e):
+        # Required fields: author, title, booktitle, year
+        # Optional fields: editor, pages, organization, publisher, address,
+        #                  month, note, key
+        return toplevel[
+            self.format_author_or_editor_and_date(e),
+            self.format_title(e, 'title'),
+            sentence(sep=' ')[
+                self.format_btitle(e, 'booktitle', as_sentence=False),
+                optional["(", pages, ")"]
+            ],
+            sentence(sep=': ')[
+                optional_field('address'),
+                optional_field('publisher'),
+            ],
+            sentence[optional_field('note')],
+            self.format_web_refs(e)
+        ]
+
+    def get_manual_template(self, e):
+        # Required fields: title
+        # Optional fields: author, organization, address, edition, month, year,
+        #                  note, key
+        return toplevel[
+            sentence(sep=' ')[
+                first_of[
+                    optional[self.format_names('author', as_sentence=False)],
+                    optional_field('organization'),
+                    "None to claim their bones"
+                ],
+                join["(", first_of[optional[date], "n.d."], ")"]
+            ],
+            self.format_btitle(e, 'title'),
+            sentence[optional_field('address')],
+            sentence[optional_field('note')],
+            self.format_web_refs(e)
+        ]
+
+    def get_mastersthesis_template(self, e):
+        # Required fields: author, title, school, year
+        # Optional fields: address, month, note, key
+        return toplevel[
+            sentence(sep=' ')[
+                self.format_names('author'),
+                join["(", date, ")"]
+            ],
+            sentence(sep=' ')[
+                self.format_btitle(e, 'title', as_sentence=False),
+                "(Master's thesis)"
+            ],
+            sentence[
+                field('school'),
+                optional_field('address'),
+            ],
+            sentence[optional_field('note')],
+        ]
+
+    def get_misc_template(self, e):
+        # Required fields: aucun
+        # Optional fields: author, title, howpublished, month, year, note, key,
+        #                  type
+        template = toplevel[
+            sentence(sep=' ')[
+                first_of[
+                    optional[self.format_names('author', as_sentence=False)],
+                    optional_field('publisher'),
+                    "None to claim their bones"
+                ],
+                join["(", first_of[optional[date], "n.d."], ")"]
+            ],
+            optional[self.format_title(e, 'title')],
+            sentence[optional_field('note')],
+            self.format_web_refs(e)
+        ]
+        return template
+
+    def get_phdthesis_template(self, e):
+        # Required fields: author, title, school, year
+        # Optional fields: address, month, note, key
+        return toplevel[
+            sentence(sep=' ')[
+                self.format_names('author'),
+                join["(", date, ")"]
+            ],
+            sentence(sep=' ')[
+                self.format_btitle(e, 'title', as_sentence=False),
+                "(Doctoral dissertation)"
+            ],
+            sentence[
+                field('school'),
+                optional_field('address'),
+            ],
+            sentence[optional_field('note')],
+        ]
+
+    def get_proceedings_template(self, e):
+        # Required fields: title, year
+        # Optional fields: editor, publisher, organization, address, month,
+        #                  note, key
+        return toplevel[
+            sentence(sep=' ')[
+                first_of[
+                    optional[self.format_editor(e, as_sentence=False)],
+                    optional_field('organization'),
+                    "None to claim their bones"
+                ],
+                join["(", first_of[optional[date], "n.d."], ")"]
+            ],
+            self.format_btitle(e, 'title'),
+            sentence(sep=': ')[
+                optional_field('address'),
+                optional_field('publisher'),
+            ],
+            sentence[optional_field('note')],
+        ]
+
+    def get_techreport_template(self, e):
+        # Required fields: author, title, institution, year
+        # Optional fields: type, number, address, month, note, key
+        return toplevel[
+            sentence(sep=' ')[
+                self.format_names('author', as_sentence=False),
+                join["(", date, ")"]
+            ],
+            self.format_btitle(e, 'title'),
+            sentence[field('institution')],
+            sentence[optional_field('note')],
+        ]
+
+    def get_unpublished_template(self, e):
+        # Required fields: author, title, note
+        # Optional fields: month, year, key
+        template = toplevel[
+            sentence(sep=' ')[
+                self.format_names('author', as_sentence=False),
+                join["(", first_of[optional[date], "n.d."], ")"]
+            ],
+            self.format_btitle(e, 'title'),
+            sentence[field('note')],
+        ]
+        return template

teachbooks-0.0.1/teachbooks/plugins/pybtex/labels/apa.py

@@ -0,0 +1,67 @@
+# -*- coding:Utf-8 -*-
+from __future__ import unicode_literals
+
+from collections import Counter
+import re
+import unicodedata
+
+from pybtex.style.labels import BaseLabelStyle
+
+
+_nonalnum_pattern = re.compile('[^A-Za-z0-9 \-]+', re.UNICODE)
+
+
+def _strip_accents(s):
+    return "".join(
+        (c for c in unicodedata.normalize('NFD', s)
+            if not unicodedata.combining(c)))
+
+
+def _strip_nonalnum(parts):
+    """Strip all non-alphanumerical characters from a list of strings.
+
+    >>> print(_strip_nonalnum([u"ÅA. B. Testing 12+}[.@~_", u" 3%"]))
+    AABTesting123
+    """
+    s = "".join(parts)
+    return _nonalnum_pattern.sub("", _strip_accents(s))
+
+
+class APALabelStyle(BaseLabelStyle):
+    def format_labels(self, sorted_entries):
+        labels = [self.format_label(entry) for entry in sorted_entries]
+        count = Counter(labels)
+        counted = Counter()
+        for label in labels:
+            if count[label] == 1:
+                yield label
+            else:
+                yield label # + chr(ord('a') + counted[label])
+                # counted.update([label])
+
+    def format_label(self, entry):
+        label = "Anonymous"
+        if 'author' in entry.persons:
+            label = self.format_author_or_editor_names(entry.persons['author'])
+        elif 'editor' in entry.persons:
+            label = self.format_author_or_editor_names(entry.persons['editor'])
+        elif 'organization' in entry.fields:
+            label = entry.fields['organization']
+            if label.startswith("The "):
+                label = label[4:]
+
+        if 'year' in entry.fields:
+            return "{}, {}".format(label, entry.fields['year'])
+        else:
+            return "{}, n.d.".format(label)
+
+    def format_author_or_editor_names(self, persons):
+        if len(persons) is 1:
+            return _strip_nonalnum(persons[0].last_names)
+        elif len(persons) is 2:
+            return "{} & {}".format(
+                _strip_nonalnum(persons[0].last_names),
+                _strip_nonalnum(persons[1].last_names))
+        else:
+            return "{} et al.".format(
+                _strip_nonalnum(persons[0].last_names))

teachbooks-0.0.1/teachbooks/plugins/pybtex/names/firstlast.py

@@ -0,0 +1,39 @@
+# -*- coding:Utf-8 -*-
+from __future__ import unicode_literals
+
+from pybtex.style.names import BaseNameStyle, name_part
+from pybtex.style.template import join
+
+
+class FirstLastStyle(BaseNameStyle):
+
+    def format(self, person, abbr=False):
+        r"""
+        Format names similarly to {vv~}{ll}{, jj}{, f.} in BibTeX.
+
+        >>> from pybtex.database import Person
+        >>> name = Person(string=r"Charles Louis Xavier Joseph de la Vall{\'e}e Poussin")
+        >>> firstlast = NameStyle().format
+
+        >>> print(firstlast(name).format().render_as('latex'))
+        Charles Louis Xavier~Joseph de~la Vall{é}e~Poussin
+        >>> print(firstlast(name).format().render_as('html'))
+        Charles Louis Xavier&nbsp;Joseph de&nbsp;la Vall<span class="bibtex-protected">é</span>e&nbsp;Poussin
+
+        >>> print(firstlast(name, abbr=True).format().render_as('latex'))
+        C.~L. X.~J. de~la Vall{é}e~Poussin
+        >>> print(firstlast(name, abbr=True).format().render_as('html'))
+        C.&nbsp;L. X.&nbsp;J. de&nbsp;la Vall<span class="bibtex-protected">é</span>e&nbsp;Poussin
+
+        >>> name = Person(first='First', last='Last', middle='Middle')
+        >>> print(firstlast(name).format().render_as('latex'))
+        First~Middle Last
+        >>> print(firstlast(name, abbr=True).format().render_as('latex'))
+        F.~M. Last
+
+        """
+        return join[
+            name_part(abbr=abbr)[person.rich_first_names + person.rich_middle_names],
+            name_part(before=' ')[person.rich_prelast_names],
+            name_part(before=' ')[person.rich_last_names],
+        ]

teachbooks-0.0.1/teachbooks/plugins/sphinxcontrib_bibtex/style/referencing/author_year_apa.py

@@ -0,0 +1,15 @@
+from dataclasses import dataclass, field
+
+from sphinxcontrib.bibtex.style.referencing import BracketStyle
+from sphinxcontrib.bibtex.style.referencing.author_year import AuthorYearReferenceStyle
+
+def bracket_style() -> BracketStyle:
+    return BracketStyle(left='(', right=')')
+
+@dataclass
+class AuthorYearRoundReferenceStyle(AuthorYearReferenceStyle):
+    bracket_parenthetical: BracketStyle = field(default_factory=bracket_style)
+    bracket_textual: BracketStyle = field(default_factory=bracket_style)
+    bracket_author: BracketStyle = field(default_factory=bracket_style)
+    bracket_label: BracketStyle = field(default_factory=bracket_style)
+    bracket_year: BracketStyle = field(default_factory=bracket_style)

teachbooks-0.0.1/teachbooks/publish.py

@@ -0,0 +1,38 @@
+import re
+import os
+
+from pathlib import Path
+
+
+def make_publish(sourcedir: Path) -> tuple[Path, Path]:
+    """Pre-process files in a Jupyter Book directory"""
+
+    # Make hidden directory that will contain the cleaned-up files
+    workdir = sourcedir.joinpath(".psorbooks", "publish")
+
+    if not os.path.exists(workdir):
+        os.makedirs(workdir)
+
+    for file in ["_config.yml", "_toc.yml"]:
+        clean_yaml(
+            sourcedir.joinpath(file),
+            workdir.joinpath(file)
+        )
+
+    return workdir.joinpath("_config.yml"), workdir.joinpath("_toc.yml")
+
+
+def clean_yaml(path_source: str | Path, path_output: str | Path) -> None:
+    """Removes sections marked with # REMOVE-FROM-PUBLISH from a yaml file"""
+
+    with open(path_source, mode="r", encoding="utf8") as f:
+        yaml_source = f.read()
+
+    yaml_output = re.sub(
+        r"# START REMOVE-FROM-PUBLISH(.|\n)*?# END REMOVE-FROM-PUBLISH", 
+        "", 
+        yaml_source
+    )
+
+    with open(path_output, mode="w", encoding="utf8") as f:
+        f.write(yaml_output)

teachbooks-0.0.1/teachbooks.egg-info/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: teachbooks
+Version: 0.0.1
+Summary: TU Delft CiTG Jupyter Book Software Stack
+Author-email: Caspar Jungbacker <c.a.a.jungbacker@tudelft.nl>
+Project-URL: Homepage, https://gitlab.tudelft.nl/interactivetextbooks-citg/extensions/teachbooks-package
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: jupyter-book~=1.0
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: pandas
+
+# TeachBooks Package
+
+The TeachBooks package contains tools to make life easier when working with (interactive) Jupyter Books. It is essentially a wrapper around Jupyter Book.
+
+Work in progress...

teachbooks-0.0.1/teachbooks.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+README.md
+pyproject.toml
+teachbooks/__init__.py
+teachbooks/publish.py
+teachbooks.egg-info/PKG-INFO
+teachbooks.egg-info/SOURCES.txt
+teachbooks.egg-info/dependency_links.txt
+teachbooks.egg-info/entry_points.txt
+teachbooks.egg-info/requires.txt
+teachbooks.egg-info/top_level.txt
+teachbooks/cli/__init__.py
+teachbooks/cli/main.py
+teachbooks/plugins/__init__.py
+teachbooks/plugins/pybtex/__init__.py
+teachbooks/plugins/pybtex/formatting/__init__.py
+teachbooks/plugins/pybtex/formatting/apa.py
+teachbooks/plugins/pybtex/labels/__init__.py
+teachbooks/plugins/pybtex/labels/apa.py
+teachbooks/plugins/pybtex/names/__init__.py
+teachbooks/plugins/pybtex/names/firstlast.py
+teachbooks/plugins/sphinxcontrib_bibtex/__init__.py
+teachbooks/plugins/sphinxcontrib_bibtex/style/__init__.py
+teachbooks/plugins/sphinxcontrib_bibtex/style/referencing/__init__.py
+teachbooks/plugins/sphinxcontrib_bibtex/style/referencing/author_year_apa.py

teachbooks-0.0.1/teachbooks.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

teachbooks-0.0.1/teachbooks.egg-info/entry_points.txt

@@ -0,0 +1,14 @@
+[console_scripts]
+teachbooks = teachbooks.cli.main:main
+
+[pybtex.style.formatting]
+apa = teachbooks.plugins.pybtex.formatting.apa:APAStyle
+
+[pybtex.style.labels]
+apa = teachbooks.plugins.pybtex.labels.apa:APALabelStyle
+
+[pybtex.style.names]
+firstlast = teachbooks.plugins.pybtex.names:FirstLastStyle
+
+[sphinxcontrib.bibtex.style.referencing]
+author_year_round = teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa:AuthorYearRoundReferenceStyle

teachbooks-0.0.1/teachbooks.egg-info/requires.txt

@@ -0,0 +1,5 @@
+jupyter-book~=1.0
+numpy
+matplotlib
+scipy
+pandas

teachbooks-0.0.1/teachbooks.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+teachbooks