PK!ܞSS HISTORY.rstHistory ======= 0.1.0 (2019-02-04) ------------------ - Initial release on PyPI. PK!>Tdd docs/Makefile# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = python -msphinx SPHINXPROJ = Kirlent SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) PK!docs/source/_static/custom.cssPK! ]Udocs/source/conf.py#!/usr/bin/env python3 # -*- coding: utf-8 -*- # # Kirlent documentation build configuration file, created by # sphinx-quickstart on Thu Sep 28 16:17:55 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ["sphinx.ext.autodoc", "pygenstub"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = ".rst" # The master toctree document. master_doc = "index" # General information about the project. project = "Kirlent" copyright = "2017-2018, H. Turgut Uyar" author = "H. Turgut Uyar" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = "0.1" # The full version, including alpha/beta/rc tags. release = "0.1" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. modindex_common_prefix = ["kirlent."] # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { "**": [ "about.html", "navigation.html", "relations.html", # needs 'show_related': True theme option to display "searchbox.html", "donate.html", ] } # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = "Kirlentdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # "papersize": "a4paper", # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, "kirlent.tex", "Kirlent Documentation", "H. Turgut Uyar", "manual") ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [(master_doc, "kirlent", "Kirlent Documentation", [author], 1)] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ( master_doc, "Kirlent", "Kirlent Documentation", author, "Kirlent", "Educational content management utilities.", "Miscellaneous", ) ] PK!@docs/source/index.rstKırlent ======= .. include:: ../README.rst .. toctree:: :maxdepth: 2 :caption: Contents: install usage markup Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` PK!zzdocs/source/install.rstInstallation ============ You can install Kırlent via PyPI:: $ pip install kirlent Kırlent depends on external programs to generate the output items. According to the type of output you want to generate, you have to install the necessary tools. At the moment, only HTML slides and PDF slides can be generated. To generate HTML slides you need to install ``kirlent_sphinx``. Kırlent uses `Decktape`_ to convert these HTML slides into PDF. It expects the command :command:`decktape` to be in the path. Decktape can be installed using npm:: $ npm install -g decktape .. _Decktape: https://github.com/astefanutti/decktape PK!F/``docs/source/markup.rstMarkup ====== Kırlent markup is based on Sphinx markup. All Sphinx syntax should be valid Kırlent syntax. You can find the differences for different output types below. Slides Markup ------------- Each slide starts with a ``slide`` directive:: .. slide:: Slide Title - point 1 - point 2 Slides can contain fragments that will be displayed incrementally:: .. slide:: Slide Title - point 1 .. container :: fragment - point 2 For two-column slides, the following template can be used:: .. slide:: Slide Title .. container:: columns .. container:: column - point 1 .. container:: column - point 2 Slides can have speaker notes:: .. slide:: Slide Title - point 1 - point 2 .. speaker-notes:: speaker notes Collection Markup ----------------- If a unit a collection of other units, it has to contain a :file:`parts.txt` file that lists the names of the source units, one on every line:: unit1 unit2 unit3 .. warning:: This syntax might change very soon. When generating output the source units will be combined. For example, if you're building a slide output for a collection, Kırlent will look for :file:`slides.rst` file under each unit, concatenate them in the given order and then do a transformation for the result. PK! oZZdocs/source/modules/cli.rst:orphan: :mod:`kirlent.cli` ================== .. automodule:: kirlent.cli :members: PK!L+uN``docs/source/modules/tasks.rst:orphan: :mod:`kirlent.tasks` ==================== .. automodule:: kirlent.tasks :members: PK!N$ll!docs/source/modules/transform.rst:orphan: :mod:`kirlent.transform` ======================== .. automodule:: kirlent.transform :members: PK!cQY+``docs/source/modules/utils.rst:orphan: :mod:`kirlent.utils` ==================== .. automodule:: kirlent.utils :members: PK!Cdocs/source/usage.rstUsage ===== Kırlent has commands for generating various types of output: - For HTML presentations, it uses RevealJS and the command is ``rv``. - For PDF presentations, it uses Decktape and the command is ``dt``. These commands take the unit to generate as their parameter. So, to generate an HTML presentation from slide sources, run the command:: $ kirlent rv expressions And for a PDF presentation:: $ kirlent dt expressions To clean up, use the ``clean`` command:: $ kirlent clean expressions PK!^R"kirlent/__init__.py# Copyright (C) 2017-2018 H. Turgut Uyar # # This file is part of Kırlent. # # Kırlent is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Kırlent is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Kırlent. If not, see . """Main module of Kırlent.""" __version__ = "0.1.0" PK!G kirlent/cli.py# Copyright (C) 2017-2018 H. Turgut Uyar # # This file is part of Kırlent. # # Kırlent is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Kırlent is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Kırlent. If not, see . """The module that contains the command line interface for Kırlent.""" import sys from argparse import ArgumentParser from pathlib import Path from . import __version__ from .tasks import TaskManager DEFAULT_SRC_ROOT = Path("content") # sig: Path """Default root folder for content sources.""" def make_parser(*, prog): """Build a parser for command line arguments. :sig: (str) -> ArgumentParser :param prog: Name of program. :return: Generated parser. """ parser = ArgumentParser(prog=prog) parser.add_argument("--version", action="version", version="%(prog)s " + __version__) parser.add_argument("--src", help="root folder for content sources") parser.add_argument("--out", help="root folder for generated output") commands = parser.add_subparsers(metavar="command", dest="command") commands.required = True unit_parser = ArgumentParser(add_help=False) unit_parser.add_argument("units", nargs="?", help="pattern for units to process") rv_parser = commands.add_parser( "rv", help="generate HTML slides using RevealJS", parents=[unit_parser] ) rv_parser.set_defaults( func=lambda m, a: m.run("generate_revealjs", pattern=a.units, exits=True) ) dt_parser = commands.add_parser( "dt", help="generate PDF slides using Decktape", parents=[unit_parser] ) dt_parser.set_defaults( func=lambda m, a: m.run("generate_decktape", pattern=a.units, exits=True) ) clean_parser = commands.add_parser( "clean", help="clean build folders", parents=[unit_parser] ) clean_parser.set_defaults( func=lambda m, a: m.run("clean_build_folders", pattern=a.units, exits=True) ) task_parser = commands.add_parser("task", help="run specific task") task_parser.add_argument("name", help="task name") task_parser.set_defaults(func=lambda m, a: m.run(a.name, exits=True)) return parser def main(argv=None): """Start the command line interface. :sig: (Optional[List[str]]) -> None :param argv: Command line arguments. """ parser = make_parser(prog="kirlent") argv_ = argv if argv is not None else sys.argv arguments = parser.parse_args(argv_[1:]) cache_root = Path.home() / ".cache" / "kirlent" cache_root.mkdir(parents=True, exist_ok=True) tasks_db = cache_root / "tasks.db" src_root = Path(arguments.src) if arguments.src is not None else DEFAULT_SRC_ROOT out_root = Path(arguments.out) if arguments.out is not None else src_root.parent / "_build" task_manager = TaskManager(src_root, out_root, deps=tasks_db) # run the handler for the selected command try: arguments.func(task_manager, arguments) except RuntimeError as e: print(e, file=sys.stderr) sys.exit(1) if __name__ == "__main__": main() PK!544kirlent/cli.pyi# THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT MANUALLY. from typing import List, Optional from argparse import ArgumentParser from pathlib import Path DEFAULT_SRC_ROOT = ... # type: Path def make_parser(*, prog: str) -> ArgumentParser: ... def main(argv: Optional[List[str]] = ...) -> None: ... PK! kirlent/model.py# Copyright (C) 2018 H. Turgut Uyar # # This file is part of Kırlent. # # Kırlent is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Kırlent is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Kırlent. If not, see . """The module that contains the data representation.""" from pathlib import Path PARTS_FILE = "parts.txt" class ContentHierarchy: """A file system hierarchy for storing content.""" def __init__(self, root): """Initialize this content hierarchy. :sig: (Path) -> None :param root: Root folder for the content. """ self.root = root.absolute() # sig: Path """Absolute path of root folder of this content hierarchy.""" @property def units(self): """Content units in this hierarchy. :sig: () -> Dict[str, Unit] """ return {p.name: Unit(p, root=self) for p in self.root.glob("*") if p.is_dir()} class Unit: """A content unit.""" def __init__(self, src, *, root): """Initialize this unit. :sig: (Path, ContentHierarchy) -> None :param src: Root folder for unit sources. :param root: Content hierarchy that contains this unit. """ self.src = src.absolute() # sig: Path """Absolute path of the root source folder of this unit.""" self.root = root # sig: ContentHierarchy """Content hierarchy that contains this unit.""" self.parts = [] # sig: List[Unit] """Subunits that make up this unit.""" parts_path = Path(self.src, PARTS_FILE) if parts_path.exists(): with open(parts_path) as f: self.parts = [p.strip() for p in f.readlines()] @property def slug(self): """Short name of this unit. :sig: () -> str """ return self.src.name def sources(self, *, medium, lang): """Get the paths of source items that make up this unit. :sig: (str, str) -> Sequence[Path] :param medium: Type of medium for which to get the sources :param lang: Language of content. :return: Source item paths. """ if len(self.parts) > 0: for part in self.parts: unit = self.root.units.get(part) yield from unit.sources(medium=medium, lang=lang) else: if medium == "slides": yield Path(self.src, f"slides.{lang}.rst") else: raise NotImplementedError( "Media other than slides haven't been implemented yet" ) def sphinx_extras(self): """Get the extra features needed for Sphinx output. :sig: () -> List[str] :return: Sphinx extras. """ return ["math"] PK!${kirlent/model.pyi# THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT MANUALLY. from typing import Dict, List, Sequence from pathlib import Path class ContentHierarchy: root = ... # type: Path def __init__(self, root: Path) -> None: ... @property def units(self) -> Dict[str, Unit]: ... class Unit: src = ... # type: Path root = ... # type: ContentHierarchy parts = ... # type: List[Unit] def __init__(self, src: Path, *, root: ContentHierarchy) -> None: ... @property def slug(self) -> str: ... def sources(self, *, medium: str, lang: str) -> Sequence[Path]: ... def sphinx_extras(self) -> List[str]: ... PK!ܘ kirlent/tasks.py# Copyright (C) 2017-2019 H. Turgut Uyar # # This file is part of Kırlent. # # Kırlent is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Kırlent is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Kırlent. If not, see . """The module that contains the tasks for building output items.""" import copy import sys from pathlib import Path from shutil import rmtree from doit.cmd_base import TaskLoader from doit.doit_cmd import DoitMain from doit.loader import generate_tasks from doit.tools import create_folder from .model import ContentHierarchy from .transform import generate_revealjs_sources SPHINX_CONFIG = { "base": { "args": [ "-b html", "-C", "-Dsource_suffix=.rv", "-Dextensions=%(ext)s", "-Dmaster_doc=%(base)s", ] }, "math": {"extensions": ["sphinx.ext.mathjax"]}, "ipython": { "extensions": [ "IPython.sphinxext.ipython_console_highlighting", "IPython.sphinxext.ipython_directive", ] }, "revealjs": {"extensions": ["kirlent_sphinx"], "args": ["-Dhtml_theme=kirlent"]}, } # sigalias: TaskDesc = Dict[str, Any] def task_create_build_folders(unit, folder): """Get the description of the build folder creation task. :sig: (kirlent.Unit, Path) -> TaskDesc :param unit: Unit to create the folders for. :param folder: Folder to create. :return: Task description. """ return { "basename": "create_build_folders", "name": unit.slug, "actions": [(create_folder, [folder])], "uptodate": [folder.exists()], "targets": [folder], } def task_clean_build_folders(unit, folder): """Get the description of the build folder cleanup task. :sig: (kirlent.Unit, Path) -> TaskDesc :param unit: Unit to remove the folders for. :param folder: Folder to remove. :return: Task description. """ return { "basename": "clean_build_folders", "name": unit.slug, "actions": [(rmtree, [folder])], "uptodate": [not folder.exists()], } def task_generate_revealjs_sources(unit, sources, output): """Get the description of the RevealJS source generation task. :sig: (kirlent.Unit, List[Path], Path) -> TaskDesc :param unit: Unit to generate the slides sources for. :param sources: Source files that make up this presentation. :param output: RevealJS file to store the result. :return: Task description. """ return { "basename": "generate_revealjs_sources", "name": unit.slug, "actions": [(generate_revealjs_sources, [sources, output])], "file_dep": sources, "task_dep": ["create_build_folders:" + unit.slug], "targets": [output], } def task_generate_revealjs_slides(unit, source, output): """Get the description of the RevealJS slides generation task. :sig: (kirlent.Unit, Path, Path) -> TaskDesc :param unit: Unit to generate the slides for. :param source: Source file of presentation. :param output: Slides file to store the result. :return: Task description. """ sphinx_args = copy.copy(SPHINX_CONFIG.get("base").get("args")) extensions = [] for extra in unit.sphinx_extras() + ["revealjs"]: section = SPHINX_CONFIG.get(extra) # TODO: check for missing section extensions.extend(section.get("extensions", [])) sphinx_args.extend(section.get("args", [])) sphinx_args.extend(["%(src)s", "%(out)s", "%(file)s"]) sphinx_cmd = "sphinx-build " + " ".join(sphinx_args) % { "src": source.parent, "out": output.parent, "file": source, "base": source.stem, "ext": ",".join(extensions), } return { "basename": "generate_revealjs", "name": unit.slug, "actions": [sphinx_cmd], "file_dep": [source], "targets": [output], } def task_generate_decktape_slides(unit, source, output): """Get the description of the Decktape slides generation task. :sig: (kirlent.Unit, Path, Path) -> TaskDesc :param unit: Unit to generate the slides for. :param source: Source file of the RevealJS slides. :param output: Slides file to store the result. :return: Task description. """ decktape_args = ["decktape", "-s", "%(size)s", "file:///%(path)s", "%(file)s"] decktape_cmd = " ".join(decktape_args) % { "size": "1121x795", "path": source.absolute(), "file": output, } return { "basename": "generate_decktape", "name": unit.slug, "actions": [decktape_cmd], "file_dep": [source], "targets": [output], } class TaskGenerator(TaskLoader): """Task loader that generates all Kırlent build tasks.""" def __init__(self, src, out, *, deps): """Initialize this task generator. :sig: (Path, Path, Path) -> None :param src: Root folder for content sources. :param out: Root folder for generated output. :param deps: Path of task dependency database for incremental builds. """ super().__init__() self.content = ContentHierarchy(src) # sig: ContentHierarchy """Content hierarchy that stores the sources for this generator.""" self.out = out # sig: Path """Root folder where this generator stores the output it generates.""" self.doit_config = {"dep_file": str(deps)} # sig: Dict[str, Any] """Settings for doit.""" def generate_tasks(self): """Generate the tasks for the units in this loader's folders. :sig: () -> Iterable[TaskDesc] :return: Task descriptions. """ for unit in self.content.units.values(): unit_out = self.out / unit.slug yield task_create_build_folders(unit, unit_out) yield task_clean_build_folders(unit, unit_out) lang = "en" slide_src = list(unit.sources(medium="slides", lang=lang)) rv_src = Path(unit_out, f"slides.{lang}.rv") yield task_generate_revealjs_sources(unit, slide_src, rv_src) rv_out = Path(unit_out, "revealjs", rv_src.with_suffix(".html").name) yield task_generate_revealjs_slides(unit, rv_src, rv_out) dt_out = Path(unit_out, rv_out.with_suffix(".pdf").name) yield task_generate_decktape_slides(unit, rv_out, dt_out) def load_tasks(self, cmd, params, args): """Provide the task data.""" return generate_tasks("kirlent", self.generate_tasks()), self.doit_config class TaskManager: """A manager for controlling tasks.""" def __init__(self, src, out, *, deps=None): """Initiliaze this task manager. :sig: (Path, Path, Path) -> None :param src: Root folder for the content sources. :param out: Root folder for generated output. :param deps: Path of task dependency database for incremental builds. """ self.loader = TaskGenerator(src, out, deps=deps) # sig: TaskGenerator """Loader for generating the tasks.""" self.runner = None # sig: Optional[DoitMain] """Runner that will process the tasks.""" def run(self, task, *, pattern=None, exits=False): """Start a task. :sig: (str, Optional[str], Optional[bool]) -> int :param task: Name of task. :param pattern: Pattern for units to process. :param exits: Whether to exit after running the task. :return: Exit code of the task. """ if self.runner is None: self.runner = DoitMain(self.loader) pattern_ = Path(pattern).name if pattern is not None else None task_ = f"{task}:{pattern_}" if pattern_ is not None else task exit_code = self.runner.run(["run", task_]) if exits: sys.exit(exit_code) return exit_code PK!Qyykirlent/tasks.pyi# THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT MANUALLY. from typing import Any, Dict, Iterable, List, Optional from pathlib import Path from doit.cmd_base import TaskLoader from doit.doit_cmd import DoitMain from .model import ContentHierarchy import kirlent TaskDesc = Dict[str, Any] def task_create_build_folders( unit: kirlent.Unit, folder: Path ) -> TaskDesc: ... def task_clean_build_folders(unit: kirlent.Unit, folder: Path) -> TaskDesc: ... def task_generate_revealjs_sources( unit: kirlent.Unit, sources: List[Path], output: Path ) -> TaskDesc: ... def task_generate_revealjs_slides( unit: kirlent.Unit, source: Path, output: Path ) -> TaskDesc: ... def task_generate_decktape_slides( unit: kirlent.Unit, source: Path, output: Path ) -> TaskDesc: ... class TaskGenerator(TaskLoader): content = ... # type: ContentHierarchy out = ... # type: Path doit_config = ... # type: Dict[str, Any] def __init__(self, src: Path, out: Path, *, deps: Path) -> None: ... def generate_tasks(self) -> Iterable[TaskDesc]: ... class TaskManager: loader = ... # type: TaskGenerator runner = ... # type: Optional[DoitMain] def __init__(self, src: Path, out: Path, *, deps: Path = ...) -> None: ... def run( self, task: str, *, pattern: Optional[str] = ..., exits: Optional[bool] = ..., ) -> int: ... PK!݁B%kirlent/transform.py# Copyright (C) 2017-2019 H. Turgut Uyar # # This file is part of Kırlent. # # Kırlent is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Kırlent is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Kırlent. If not, see . """The module that contains the markup transformations.""" from io import StringIO from pathlib import Path from .utils import relative_path def generate_revealjs_sources(sources, target): """Combine a number of Kırlent sources and convert to a RevealJS file. :sig: (List[Path], Path) -> None :param sources: Paths of Kırlent source files. :param target: Path of target RevealJS file. """ stream = StringIO() for source in sources: with source.open() as f: for line in f.readlines(): if ".. image::" in line: asset_path = line.split(".. image::")[1].strip() full_path = Path(source.parent, asset_path) rel_path = relative_path(full_path, target.parent) line = line.replace(asset_path, str(rel_path)) print(line, file=stream, end="") print("\n\n", file=stream) content = stream.getvalue() with target.open(mode="w") as f: f.write(content) PK!mPkirlent/transform.pyi# THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT MANUALLY. from typing import List from pathlib import Path def generate_revealjs_sources(sources: List[Path], target: Path) -> None: ... PK!&Fkirlent/utils.py# Copyright (C) 2017 H. Turgut Uyar # # This file is part of Kırlent. # # Kırlent is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Kırlent is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Kırlent. If not, see . """The module that contains various utility functions.""" from itertools import dropwhile, zip_longest from pathlib import Path def relative_path(src, dst): """Get the relative path of a file starting from a destination folder. :sig: (Path, Path) -> Path :param src: Path of source file to find the relative path for. :param dst: Path of destination folder to start the relative path from. :return: Relative path from start to source file. """ parts = zip_longest(src.absolute().parts, dst.absolute().parts) path_diff = dropwhile(lambda ps: ps[0] == ps[1], parts) down_parts, up_parts = zip(*path_diff) up_path = Path(*[".." for p in up_parts if p is not None]) down_path = Path(*[p for p in down_parts if p is not None]) return up_path / down_path PK!Cekirlent/utils.pyi# THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT MANUALLY. from pathlib import Path def relative_path(src: Path, dst: Path) -> Path: ... PK!% d''tests/conftest.pyfrom pytest import fixture from collections import namedtuple from pathlib import Path from shutil import rmtree KIRLENT_ROOT = Path("/dev/shm/kirlent") SrcOutPaths = namedtuple("Paths", ["src", "out"]) @fixture(scope="session") def kirlent_env(): """Source and build paths for the entire content.""" src_root = Path(KIRLENT_ROOT, "content") out_root = Path(src_root.parent, "_build") rmtree(KIRLENT_ROOT, ignore_errors=True) KIRLENT_ROOT.mkdir(parents=True) src_root.mkdir() yield SrcOutPaths(src_root, out_root) rmtree(KIRLENT_ROOT) @fixture def unit1(kirlent_env): """Source and build paths of a unit with slides.""" src, out = Path(kirlent_env.src, "unit1"), Path(kirlent_env.out, "unit1") rmtree(src, ignore_errors=True) rmtree(out, ignore_errors=True) src.mkdir() Path(src, "slides.en.rst").write_text("") yield SrcOutPaths(src, out) rmtree(src, ignore_errors=True) rmtree(out, ignore_errors=True) @fixture def unit2(kirlent_env): """Source and build paths of a unit with slides.""" src, out = Path(kirlent_env.src, "unit2"), Path(kirlent_env.out, "unit2") rmtree(src, ignore_errors=True) rmtree(out, ignore_errors=True) src.mkdir() Path(src, "slides.en.rst").write_text("") yield SrcOutPaths(src, out) rmtree(src, ignore_errors=True) rmtree(out, ignore_errors=True) @fixture def unit3(kirlent_env, unit1, unit2): """Source and build paths of a unit with parts.""" src, out = Path(kirlent_env.src, "unit3"), Path(kirlent_env.out, "unit3") rmtree(src, ignore_errors=True) rmtree(out, ignore_errors=True) src.mkdir() Path(src, "parts.txt").write_text("unit1\nunit2\n") yield SrcOutPaths(src, out) rmtree(src, ignore_errors=True) rmtree(out, ignore_errors=True) PK!u tests/test_cli.pyfrom pytest import raises import re from pkg_resources import get_distribution from kirlent import cli def test_help_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--help"]) out, err = capsys.readouterr() assert out.startswith("usage: ") def test_version_should_print_version_number_and_exit(capsys): version = get_distribution("kirlent").version with raises(SystemExit): cli.main(argv=["kirlent", "--version"]) out, err = capsys.readouterr() assert out == "kirlent %(ver)s\n" % {"ver": version} # TODO: Add test for the case when src directory is given # TODO: Add test for the case when out directory is given def test_missing_command_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*required: command.*", err, re.DOTALL) def test_invalid_command_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "foo"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*invalid choice: 'foo'.*", err, re.DOTALL) def test_unrecognized_argument_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--foo", "clean", "unit1"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*unrecognized arguments: --foo.*", err, re.DOTALL) # TODO: Add test for rv command with unit glob # TODO: Add test for rv command without unit glob def test_rv_unrecognized_argument_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--foo", "rv", "unit1"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*unrecognized arguments: --foo.*", err, re.DOTALL) # TODO: Add test for dt command with unit glob # TODO: Add test for dt command without unit glob def test_dt_unrecognized_argument_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--foo", "dt", "unit1"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*unrecognized arguments: --foo.*", err, re.DOTALL) # TODO: Add test for clean command with unit glob # TODO: Add test for clean command without unit glob def test_clean_unrecognized_argument_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--foo", "clean", "unit1"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*unrecognized arguments: --foo.*", err, re.DOTALL) # TODO: Add test for task command with valid task name def test_task_invalid_name_should_print_error_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "task", "foo"]) out, err = capsys.readouterr() assert re.match(r'^ERROR: .*invalid parameter: "foo".*', err, re.DOTALL) def test_task_missing_name_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--foo", "task"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*required: name.*", err, re.DOTALL) def test_task_unrecognized_argument_should_print_usage_and_exit(capsys): with raises(SystemExit): cli.main(argv=["kirlent", "--foo", "task", "create_build_folders"]) out, err = capsys.readouterr() assert re.match(r"^usage: .*unrecognized arguments: --foo.*", err, re.DOTALL) PK!6] tests/test_model.pyfrom pytest import fixture from pathlib import Path from kirlent.model import ContentHierarchy @fixture(scope="module") def kirlent_content(kirlent_env): """A content hierarchy that stores the content sources.""" return ContentHierarchy(kirlent_env.src) def test_content_hierarchy_path_should_be_absolute(kirlent_content): assert str(kirlent_content.root)[0] == "/" def test_content_hierarchy_should_pick_up_units(kirlent_content, unit1): assert kirlent_content.units.get("unit1") is not None def test_content_hierarchy_should_ignore_non_folders_as_units(kirlent_content): Path(kirlent_content.root, "unit").touch() assert kirlent_content.units.get("unit") is None Path(kirlent_content.root, "unit").unlink() def test_content_hierarchy_should_ignore_sub_folders_as_units(kirlent_content, unit1): Path(unit1.src, "unit1a").mkdir() assert kirlent_content.units.get("unit1a") is None def test_unit_source_path_should_be_absolute(kirlent_content, unit1): assert str(kirlent_content.units.get("unit1").src)[0] == "/" def test_unit_should_have_reference_to_hierarchy(kirlent_content, unit1): assert kirlent_content.units.get("unit1").root == kirlent_content def test_unit_without_parts_should_have_empty_list_of_parts(kirlent_content, unit1): assert kirlent_content.units.get("unit1").parts == [] def test_unit_with_parts_should_have_list_of_part_slugs(kirlent_content, unit3): assert kirlent_content.units.get("unit3").parts == ["unit1", "unit2"] def test_unit_slug_should_be_same_as_folder_basename(kirlent_content, unit1): assert kirlent_content.units.get("unit1").slug == "unit1" def test_unit_sources_should_be_sequence_of_absolute_paths(kirlent_content, unit1): unit = kirlent_content.units.get("unit1") assert list(unit.sources(medium="slides", lang="en")) == [ Path(unit1.src, "slides.en.rst").absolute() ] def test_unit_sources_nonexisting_language_should_be_included(kirlent_content, unit1): unit = kirlent_content.units.get("unit1") assert list(unit.sources(medium="slides", lang="tr")) == [ Path(unit1.src, "slides.tr.rst").absolute() ] def test_unit_sources_with_parts_should_be_sequence_of_part_paths( kirlent_content, unit1, unit2, unit3 ): unit = kirlent_content.units.get("unit3") assert list(unit.sources(medium="slides", lang="en")) == [ Path(unit1.src, "slides.en.rst").absolute(), Path(unit2.src, "slides.en.rst").absolute(), ] PK!Ejo;;tests/test_tasks.pyfrom pytest import fixture from pathlib import Path from time import sleep from kirlent.tasks import TaskManager MTIME_DELAY = 0.1 @fixture(scope="module") def task_manager(kirlent_env): """A task manager for generating and running test tasks.""" deps = Path(kirlent_env.src.parent, "tasks.db") yield TaskManager(kirlent_env.src, kirlent_env.out, deps=deps) def test_create_build_folders_should_create_non_existing_unit(task_manager, unit1): assert not unit1.out.exists() task_manager.run("create_build_folders:unit1") assert unit1.out.exists() def test_create_build_folders_should_not_touch_existing_unit(task_manager, unit1): unit1.out.mkdir() mtime_orig = unit1.out.stat().st_mtime_ns sleep(MTIME_DELAY) task_manager.run("create_build_folders:unit1") assert unit1.out.stat().st_mtime_ns == mtime_orig def test_create_build_folders_default_should_create_all_units(task_manager, unit1, unit2): assert not unit1.out.exists() assert not unit2.out.exists() task_manager.run("create_build_folders") assert unit1.out.exists() assert unit2.out.exists() def test_clean_build_folders_should_delete_unit_with_contents(task_manager, unit1): unit1.out.mkdir() Path(unit1.out, "index.txt").touch() task_manager.run("clean_build_folders:unit1") assert not unit1.out.exists() def test_clean_build_folders_should_not_fail_if_unit_does_not_exist(task_manager, unit1): assert not unit1.out.exists() exit_code = task_manager.run("clean_build_folders:unit1") assert exit_code == 0 def test_clean_build_folders_default_should_delete_all_unit_folders(task_manager, unit1, unit2): unit1.out.mkdir() unit2.out.mkdir() task_manager.run("clean_build_folders") assert not unit1.out.exists() assert not unit2.out.exists() def test_generate_revealjs_sources_should_generate_file_with_extension_rv(task_manager, unit1): assert not unit1.out.exists() task_manager.run("generate_revealjs_sources:unit1") assert Path(unit1.out, "slides.en.rv").exists() def test_generate_revealjs_sources_should_not_regenerate_if_sources_not_modified( task_manager, unit1 ): assert not unit1.out.exists() task_manager.run("generate_revealjs_sources:unit1") mtime_orig = Path(unit1.out, "slides.en.rv").stat().st_mtime_ns sleep(MTIME_DELAY) task_manager.run("generate_revealjs_sources:unit1") assert Path(unit1.out, "slides.en.rv").stat().st_mtime_ns == mtime_orig def test_generate_revealjs_sources_should_regenerate_if_sources_modified(task_manager, unit1): assert not unit1.out.exists() task_manager.run("generate_revealjs_sources:unit1") mtime_orig = Path(unit1.out, "slides.en.rv").stat().st_mtime_ns sleep(MTIME_DELAY) Path(unit1.src, "slides.en.rst").write_text("..") task_manager.run("generate_revealjs_sources:unit1") assert Path(unit1.out, "slides.en.rv").stat().st_mtime_ns > mtime_orig def test_generate_revealjs_sources_should_regenerate_if_parts_file_modified( task_manager, unit3 ): assert not unit3.out.exists() task_manager.run("generate_revealjs_sources:unit3") mtime_orig = Path(unit3.out, "slides.en.rv").stat().st_mtime_ns sleep(MTIME_DELAY) Path(unit3.src, "parts.txt").write_text("unit1\n") task_manager.run("generate_revealjs_sources:unit3") assert Path(unit3.out, "slides.en.rv").stat().st_mtime_ns > mtime_orig def test_generate_revealjs_sources_should_regenerate_if_part_modified( task_manager, unit1, unit3 ): assert not unit3.out.exists() task_manager.run("generate_revealjs_sources:unit3") mtime_orig = Path(unit3.out, "slides.en.rv").stat().st_mtime_ns sleep(MTIME_DELAY) Path(unit1.src, "slides.en.rst").write_text("..") task_manager.run("generate_revealjs_sources:unit3") assert Path(unit3.out, "slides.en.rv").stat().st_mtime_ns > mtime_orig PK!j<$$tests/test_utils.pyfrom pathlib import Path from kirlent.utils import relative_path def test_relative_path_target_in_same_folder_should_be_target_name(): assert relative_path(Path("d1", "f"), Path("d1")).parts == ("f",) def test_relative_path_target_in_child_folder_should_start_with_child(): assert relative_path(Path("d1", "d2", "f"), Path("d1")).parts == ("d2", "f") def test_relative_path_target_in_grandchild_folder_should_start_with_two_children(): assert relative_path(Path("d1", "d2", "d3", "f"), Path("d1")).parts == ("d2", "d3", "f") def test_relative_path_target_in_parent_folder_should_start_with_double_dots(): assert relative_path(Path("d1", "f"), Path("d1", "d2")).parts == ("..", "f") def test_relative_path_target_in_grandparent_folder_should_start_with_two_double_dots(): assert relative_path(Path("d1", "f"), Path("d1", "d2", "d3")).parts == ("..", "..", "f") def test_relative_path_target_in_diagonal_folder_should_go_up_and_down(): assert relative_path(Path("d1", "d2", "f"), Path("d1", "d3")).parts == ("..", "d2", "f") PK!HuoD(,(kirlent-0.1.0.dist-info/entry_points.txtN+I/N.,(),I+z9Vy\\PK!|wfKK#kirlent-0.1.0.dist-info/LICENSE.txt GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . PK!HڽTUkirlent-0.1.0.dist-info/WHEEL A н#Z;/"d&F[xzw@Zpy3Fv]\fi4WZ^EgM_-]#0(q7PK!HxoX* kirlent-0.1.0.dist-info/METADATAVN+7}W҇^t zqѥB_ dkomo`ToR%ٌ3gfΜ/U>hg3ؑU՘mm9⺭k N6WNHP+J1:g]T16!K)xBhy]^rݣEWن\ü⨍|0k}F_GX+m2hs$/jatّux0cBsh\* 0#Tj.w6ӱp9gpm95w IϾZ|`TDǭޕ^յ%\([4ᄆqcN\rSpT>}yOHgM)zfmcqC̠p:‡Ãm9 sgf9lIn'qtsu/+l\ 7O0^7gt/h5sF>D!]y]VTlOF՚f Rq :"0 ڨ̉I5,)bR7H sQAj7bV!#ʴ]!h!$y@Q,#Ԅ -7ʗ鞄9Tg.= nJEvĶQ^y6PW<^GR&-\ Ck= \X kKqġ#Oܡy*, N]H{ ]@H^!}=jLotr)R ?C]LA pGI+NJ, +D+y z6WzυtƆbU7uE0aQS#iU?M>Nv&ݩPK!H' kirlent-0.1.0.dist-info/RECORDurZ}= La f!$@bLByHOߪm[v|d&l4ta@؍0y6 nzfG<ܚyL%m2Q]`}F7DaLM. ʯwW@ߊ B?CM0yOqjd?1lv OZ`+fYe FuڳrFof6lW N c1PmnZ7{] ^tHf&ׂ}e6hy!mVwf3&{>mUrE 4T6v .D~ +lbMIWGC9wڥ}}&ў&m:E0vf|\!Q5Iε\e{RW3\Η |J $mqf|Ԕ8Gp_)$z'Hz:uB=YNR⣁+5W77'Ⱦ:;;m Sc]K9c_yշW^N[w+u7b)4o^u$5'KbŦ/׿bI◻-R;+yn{Aj@VqؿbƫJ4ə^֋a`ض;j!})j~ 羚aJgO#Q6:]:^+}0bN=>fj8z& ,mxrP!'@~5e4o>{T UM]x G {3m eY~ ;+=Y[*'b 9>6IUd-;Q|a<8d*w'%Un8.ux8١ @&7.MlUM{ лn߄ЄUݼAF#"3 ;Z",WӐOğ֧dF;Alrtx 47i#^hK PK!ܞSS HISTORY.rstPK!>Tdd |docs/MakefilePK! docs/source/_static/custom.cssPK! ]UGdocs/source/conf.pyPK!@Gdocs/source/index.rstPK!zzWdocs/source/install.rstPK!F/``docs/source/markup.rstPK! oZZ!docs/source/modules/cli.rstPK!L+uN``-"docs/source/modules/tasks.rstPK!N$ll!"docs/source/modules/transform.rstPK!cQY+``s#docs/source/modules/utils.rstPK!C$docs/source/usage.rstPK!^R"C&kirlent/__init__.pyPK!G x)kirlent/cli.pyPK!5447kirlent/cli.pyiPK! 8kirlent/model.pyPK!${Ekirlent/model.pyiPK!ܘ Hkirlent/tasks.pyPK!Qyyikirlent/tasks.pyiPK!݁B%pokirlent/transform.pyPK!mPvvkirlent/transform.pyiPK!&Fiwkirlent/utils.pyPK!Ce}kirlent/utils.pyiPK!% d''?~tests/conftest.pyPK!u tests/test_cli.pyPK!6] Mtests/test_model.pyPK!Ejo;;Atests/test_tasks.pyPK!j<$$tests/test_utils.pyPK!HuoD(,(kirlent-0.1.0.dist-info/entry_points.txtPK!|wfKK#pkirlent-0.1.0.dist-info/LICENSE.txtPK!HڽTU:kirlent-0.1.0.dist-info/WHEELPK!HxoX* ;kirlent-0.1.0.dist-info/METADATAPK!H' y@kirlent-0.1.0.dist-info/RECORDPK!!F