codetrail-cli 1.4.1__py3-none-any.whl

codetrail/web/static/vendor/inter/LICENSE.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2016 The Inter Project Authors (https://github.com/rsms/inter)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

codetrail/web/static/vendor/inter/VERSION

@@ -0,0 +1,6 @@
+Inter 4.1
+source: https://github.com/rsms/inter/releases/download/v4.1/Inter-4.1.zip (web/InterVariable.woff2, web/InterVariable-Italic.woff2, LICENSE.txt)
+licence: SIL Open Font License 1.1 (LICENSE.txt)
+sha256:
+  693b77d4f32ee9b8bfc995589b5fad5e99adf2832738661f5402f9978429a8e3  InterVariable.woff2
+  e564f652916db6c139570fefb9524a77c4d48f30c92928de9db19b6b5c7a262a  InterVariable-Italic.woff2

codetrail/web/static/vendor/noto-sans-arabic/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2022 The Noto Project Authors (https://github.com/notofonts/arabic)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

codetrail/web/static/vendor/noto-sans-arabic/VERSION

@@ -0,0 +1,12 @@
+Noto Sans Arabic 2.013
+source: https://github.com/notofonts/arabic/releases/download/NotoSansArabic-v2.013/NotoSansArabic-v2.013.zip
+  (NotoSansArabic/unhinted/slim-variable-ttf/NotoSansArabic[wght].ttf and OFL.txt)
+converted: the release ships no WOFF2, so the TTF was compressed losslessly; with every tool pinned, this gives the
+  same bytes again:
+  uvx --python 3.14.7 --from 'fonttools[woff]==4.60.2' --with 'brotli==1.2.0' fonttools ttLib.woff2 compress -o NotoSansArabic-wght.woff2 'NotoSansArabic[wght].ttf'
+licence: SIL Open Font License 1.1 (OFL.txt)
+sha256 of the sources:
+  1301aceaea84c501cf2e6dcfb3182e2328c8eae5725817fcb239672bda7154f1  NotoSansArabic-v2.013.zip
+  3fae4d7239d1faa55b234bda8091019a5251ff79df40d5e29367d84bed2a8138  NotoSansArabic[wght].ttf
+sha256:
+  011d31980bdc998dd3a00e365326c69e2417a76ecff020ffb8cb84752adc45f2  NotoSansArabic-wght.woff2

codetrail/web/target_view.py

@@ -0,0 +1,63 @@
+"""What the page reads for one target: the sources' manifest, the fact store and the source text.
+
+Source text is served only for paths listed in the manifest's files, which passed the exclusion rules, and only from
+`source/`.
+"""
+
+from __future__ import annotations
+
+from collections import Counter
+from collections.abc import Iterator
+from contextlib import contextmanager
+from pathlib import PurePosixPath
+
+from codetrail.config import Paths
+from codetrail.database import connect
+from codetrail.facts.store import FactStore
+from codetrail.repo.source import SourceManifest
+
+MAX_SOURCE_BYTES = 2_000_000
+
+
+class TargetView:
+    def __init__(self, paths: Paths, name: str) -> None:
+        self.name = name
+        self.data = paths.target_data(name)
+
+    def manifest(self) -> SourceManifest | None:
+        return SourceManifest.load(self.data / "source.json")
+
+    @contextmanager
+    def store(self) -> Iterator[FactStore]:
+        connection = connect(self.data / "codetrail.db")
+        try:
+            yield FactStore(connection)
+        finally:
+            connection.close()
+
+    def areas(self) -> list[tuple[str, int]]:
+        """Top-level folders of the visible files, with how many files each holds."""
+        manifest = self.manifest()
+        if manifest is None:
+            return []
+        counts = Counter(path.split("/", 1)[0] for path in manifest.files if "/" in path)
+        return sorted(counts.items())
+
+    def files_under(self, scope: str) -> list[str]:
+        manifest = self.manifest()
+        prefix = scope.rstrip("/") + "/"
+        return [path for path in manifest.files if path.startswith(prefix)] if manifest else []
+
+    def read_source(self, path: str) -> str | None:
+        """The text of a visible file, or None when it isn't visible, isn't text, or is too large to show."""
+        manifest = self.manifest()
+        if manifest is None or path not in manifest.files:
+            return None
+        root = (self.data / "source").resolve()
+        file = (root / PurePosixPath(path)).resolve()
+        if not file.is_relative_to(root) or not file.is_file() or file.stat().st_size > MAX_SOURCE_BYTES:
+            return None
+        try:
+            return file.read_text(encoding="utf-8")
+        except UnicodeDecodeError:
+            return None

codetrail/web/templates/answers.html

@@ -0,0 +1,25 @@
+{% extends "base.html" %}
+{% block title %}{{ _("Saved answers") }}{% endblock %}
+{% block content %}
+<div class="wide">
+<header class="page-head">
+  <h1>{{ _("Saved answers") }}</h1>
+  <p class="muted">{{ _("Answers you saved to the guide, newest first. They aren't rewritten when the code changes; a mark shows when the files they were written from have changed.") }}</p>
+</header>
+{% if answers %}
+<ul class="list">
+  {% for answer, changed in answers %}
+  <li><a class="grow" href="/pages/{{ answer.id }}" dir="auto">{{ answer.title }}</a>
+    {% if changed %}<span class="pill pill-changed">{{ _("sources changed") }}</span>{% endif %}
+    <span class="faint">{{ (answer.meta.get("asked_at") if answer.meta.get("asked_at") is string else "")[:10] }}</span></li>
+  {% endfor %}
+</ul>
+{% else %}
+<section class="empty">
+  <h2>{{ _("Keep the answers worth keeping") }}</h2>
+  <p>{{ _("Ask a question from any page (press A), then choose Save to guide. Saved answers become part of the guide, and search finds them.") }}</p>
+  <button type="button" class="button primary" data-ask-open>{{ _("Ask a question") }}</button>
+</section>
+{% endif %}
+</div>
+{% endblock %}

codetrail/web/templates/area.html

@@ -0,0 +1,46 @@
+{% extends "base.html" %}
+{% block title %}{{ scope }}{% endblock %}
+{% block content %}
+<div class="wide">
+<header class="page-head">
+  <p class="eyebrow">{{ _("Folder") }}</p>
+  <h1 lang="en" dir="ltr">{{ scope }}/</h1>
+  <p class="muted">{% trans count=files|length %}{{ count }} visible file{% pluralize %}{{ count }} visible files{% endtrans %}</p>
+</header>
+
+{% if system.nodes %}
+<section>
+  <div class="section-head"><h2>{{ _("Where it fits") }}</h2><a href="/system">{{ _("See the whole system") }}</a></div>
+  <p class="muted">{{ _("The parts in this folder and the parts they connect to.") }}</p>
+  {% with diagram=system %}{% include "diagram.html" %}{% include "system_legend.html" %}{% endwith %}
+</section>
+{% endif %}
+
+{% for project, diagram in projects %}
+<section>
+  <h2>{{ _("Dependencies of") }} <a href="/facts/{{ project.id|urlencode|replace("/", "%2F") }}" lang="en" dir="ltr">{{ project.attributes.get("name", project.id) }}</a></h2>
+  {% with diagram=diagram %}{% include "diagram.html" %}{% endwith %}
+</section>
+{% endfor %}
+
+{% if imports.nodes %}
+<section>
+  <h2>{{ _("Imports") }}</h2>
+  {% if imports.rolled_up %}<p class="muted">{{ _("Too many modules to show one by one: folders are shown, with the number of imports on each arrow.") }}</p>{% endif %}
+  {% with diagram=imports %}{% include "diagram.html" %}{% endwith %}
+</section>
+{% endif %}
+
+{% if decisions %}
+<section>
+  <h2>{{ _("Decisions") }}</h2>
+  <ul class="list" lang="en" dir="ltr">{% for decision in decisions %}<li><a class="grow" href="/facts/{{ decision.id|urlencode|replace("/", "%2F") }}">{{ decision.attributes.number }}. {{ decision.attributes.title }}</a></li>{% endfor %}</ul>
+</section>
+{% endif %}
+
+<section>
+  <h2>{{ _("Files") }}</h2>
+  <ul class="files" lang="en" dir="ltr">{% for path in files %}<li><a href="/source/{{ path|urlencode }}">{{ path }}</a></li>{% endfor %}</ul>
+</section>
+</div>
+{% endblock %}

codetrail/web/templates/base.html

@@ -0,0 +1,37 @@
+{% from "macros.html" import cost with context %}{% from "layout/icons.html" import icon %}<!doctype html>
+<html lang="{{ language.code }}" dir="{{ language.direction }}">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name="codetrail-token" content="{{ token }}">
+  <meta name="color-scheme" content="light dark">
+  <title>{% block title %}{{ target }}{% endblock %} · Codetrail</title>
+  <link rel="icon" href="/static/brand/favicon.svg" type="image/svg+xml">
+  <link rel="preload" href="/static/vendor/inter/InterVariable.woff2" as="font" type="font/woff2" crossorigin>
+  <link rel="stylesheet" href="/static/css/tokens.css">
+  <link rel="stylesheet" href="/static/css/base.css">
+  <link rel="stylesheet" href="/static/css/layout.css">
+  <link rel="stylesheet" href="/static/css/components.css">
+  <link rel="stylesheet" href="/static/css/content.css">
+  <link rel="stylesheet" href="/static/css/print.css" media="print">
+  <script src="/static/js/theme-init.js"></script>
+  <script type="module" src="/static/js/main.js"></script>
+</head>
+<body>
+  <a class="skip-link" href="#content">{{ _("Skip to content") }}</a>
+  {% include "layout/header.html" %}
+  <div class="shell">
+    {% include "layout/sidebar.html" %}
+    <div class="page-area">
+      <main id="content" class="content" tabindex="-1">
+        {% block content %}{% endblock %}
+      </main>
+      {% include "layout/outline.html" %}
+    </div>
+  </div>
+  {% include "layout/ask_panel.html" %}
+  {% include "layout/palette.html" %}
+  {% include "layout/shortcuts.html" %}
+  {% include "layout/update_dialog.html" %}
+</body>
+</html>

codetrail/web/templates/decisions.html

@@ -0,0 +1,30 @@
+{% extends "base.html" %}
+{% block title %}{{ _("Decisions") }}{% endblock %}
+{% block content %}
+<div class="wide">
+<header class="page-head">
+  <h1>{{ _("Decisions") }}</h1>
+  <p class="muted">{{ _("The repository's architecture decision records, as Codetrail found them.") }}</p>
+</header>
+{% if decisions %}
+<table class="decisions" lang="en" dir="ltr">
+  <thead><tr><th>#</th><th>Title</th><th>Status</th><th>Date</th></tr></thead>
+  <tbody>
+  {% for decision in decisions %}
+  <tr>
+    <td><a href="/facts/{{ decision.id|urlencode|replace("/", "%2F") }}">{{ decision.attributes.number }}</a></td>
+    <td><a href="/source/{{ decision.attributes.path|urlencode }}">{{ decision.attributes.title }}</a></td>
+    <td>{% if decision.attributes.get("status") %}<span class="pill">{{ decision.attributes.get("status", "") }}</span>{% endif %}</td>
+    <td class="faint">{{ decision.attributes.get("date", "") }}</td>
+  </tr>
+  {% endfor %}
+  </tbody>
+</table>
+{% else %}
+<section class="empty">
+  <h2>{{ _("No decisions found") }}</h2>
+  <p>{{ _("Codetrail looks for architecture decision records where the target's settings say they live.") }}</p>
+</section>
+{% endif %}
+</div>
+{% endblock %}

codetrail/web/templates/diagram.html

@@ -0,0 +1,10 @@
+{% from "layout/icons.html" import icon %}
+<figure class="diagram-block" lang="en" dir="ltr" data-alt="{{ diagram.nodes|map(attribute='label')|join(', ') }}">
+  <div class="diagram-tools"><button type="button" class="icon-button" data-diagram-enlarge aria-pressed="false" aria-label="{{ _('Enlarge the diagram') }}" title="{{ _('Enlarge the diagram') }}">{{ icon("expand") }}</button></div>
+  <pre class="diagram">{{ diagram.d2 }}</pre>
+  <figcaption>
+    <details><summary>{{ _("What each box links to") }}</summary>
+      <ul>{% for node in diagram.nodes %}<li><a href="{{ node.link }}">{{ node.label }}</a></li>{% endfor %}</ul>
+    </details>
+  </figcaption>
+</figure>

codetrail/web/templates/digests.html

@@ -0,0 +1,24 @@
+{% extends "base.html" %}
+{% block title %}{{ _("Digests") }}{% endblock %}
+{% block content %}
+<div class="wide">
+<header class="page-head">
+  <h1>{{ _("Digests") }}</h1>
+  <p class="muted">{{ _("What changed in the repository at each update, and why, newest first.") }}</p>
+</header>
+{% if digests %}
+<ul class="list" lang="en" dir="ltr">
+  {% for digest in digests %}
+  <li><a class="grow" href="/pages/{{ digest.id }}">{{ digest.title }}</a>
+    {% if digest.id in unread %}<span class="pill pill-read" lang="{{ language.code }}" dir="{{ language.direction }}">{{ _("unread") }}</span>{% endif %}
+    <span class="faint">{{ (digest.meta.get("written_at") if digest.meta.get("written_at") is string else "")[:10] }}</span></li>
+  {% endfor %}
+</ul>
+{% else %}
+<section class="empty">
+  <h2>{{ _("No digests yet") }}</h2>
+  <p>{{ _("Each update writes a digest of what changed since the last one.") }}</p>
+</section>
+{% endif %}
+</div>
+{% endblock %}