shellman 1.0.1__tar.gz → 1.0.2__tar.gz

{shellman-1.0.1 → shellman-1.0.2}/CHANGELOG.md

@@ -6,6 +6,23 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.0.2](https://github.com/pawamoy/shellman/releases/tag/1.0.2) - 2025-03-27
+
+<small>[Compare with 1.0.1](https://github.com/pawamoy/shellman/compare/1.0.1...1.0.2)</small>
+
+### Deprecations
+
+Submodules are deprecated, import from the top-level `shellman` module instead.
+
+### Bug Fixes
+
+- Return correct tag instances from `from_lines`, fixing parsing of `file` tags (value and description) ([e597d9d](https://github.com/pawamoy/shellman/commit/e597d9d33bc6767fb653db37b910607f1d3f476d) by Timothée Mazzucotelli). [Issue-mkdocstrings-shell-3](https://github.com/mkdocstrings/shell/issues/3)
+
+### Code Refactoring
+
+- Re-expose submodules as deprecated ([c8f6676](https://github.com/pawamoy/shellman/commit/c8f66760ceb1428a94543ddbdab2e2c8111c3784) by Timothée Mazzucotelli).
+- Move submodules under internal folder, sync API and docs ([60de99f](https://github.com/pawamoy/shellman/commit/60de99f3df4e13e2321a84797a4e3aaa103efdd0) by Timothée Mazzucotelli).
+
 ## [1.0.1](https://github.com/pawamoy/shellman/releases/tag/1.0.1) - 2024-11-25
 
 <small>[Compare with 1.0.0](https://github.com/pawamoy/shellman/compare/1.0.0...1.0.1)</small>

shellman-1.0.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev@pawamoy.fr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

{shellman-1.0.1 → shellman-1.0.2}/CONTRIBUTING.md

@@ -1,7 +1,6 @@
 # Contributing
 
-Contributions are welcome, and they are greatly appreciated!
-Every little bit helps, and credit will always be given.
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
 
 ## Environment setup
 
@@ -14,11 +13,7 @@ cd shellman
 make setup
 ```
 
-> NOTE:
-> If it fails for some reason,
-> you'll need to install
-> [uv](https://github.com/astral-sh/uv)
-> manually.
+> NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually.
 >
 > You can install it with:
 >
@@ -26,8 +21,7 @@ make setup
 > curl -LsSf https://astral.sh/uv/install.sh | sh
 > ```
 >
-> Now you can try running `make setup` again,
-> or simply `uv sync`.
+> Now you can try running `make setup` again, or simply `uv sync`.
 
 You now have the dependencies installed.
 
@@ -37,15 +31,10 @@ Run `make help` to see all the available actions!
 
 ## Tasks
 
-The entry-point to run commands and tasks is the `make` Python script,
-located in the `scripts` directory. Try running `make` to show the available commands and tasks.
-The *commands* do not need the Python dependencies to be installed,
-while the *tasks* do.
-The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
+The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed,
+while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
 
-If you work in VSCode, we provide
-[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)
-for the project.
+If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
 
 ## Development
 
@@ -64,17 +53,13 @@ As usual:
     1. go to http://localhost:8000 and check that everything looks good
 1. follow our [commit message convention](#commit-message-convention)
 
-If you are unsure about how to fix or ignore a warning,
-just let the continuous integration fail,
-and we will help you during review.
+If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
 
 Don't bother updating the changelog, we will take care of this.
 
 ## Commit message convention
 
-Commit messages must follow our convention based on the
-[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
-or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
+Commit messages must follow our convention based on the [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
 
 ```
 <type>[(scope)]: Subject
@@ -82,10 +67,7 @@ or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.
 [Body]
 ```
 
-**Subject and body must be valid Markdown.**
-Subject must have proper casing (uppercase for first letter
-if it makes sense), but no dot at the end, and no punctuation
-in general.
+**Subject and body must be valid Markdown.** Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
 
 Scope and body are optional. Type can be:
 
@@ -101,9 +83,7 @@ Scope and body are optional. Type can be:
 - `style`: A change in code style/format.
 - `tests`: About tests.
 
-If you write a body, please add trailers at the end
-(for example issues and PR references, or co-authors),
-without relying on GitHub's flavored Markdown:
+If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
 
 ```
 Body.
@@ -112,16 +92,9 @@ Issue #10: https://github.com/namespace/project/issues/10
 Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
 ```
 
-These "trailers" must appear at the end of the body,
-without any blank lines between them. The trailer title
-can contain any character except colons `:`.
-We expect a full URI for each trailer, not just GitHub autolinks
-(for example, full GitHub URLs for commits and issues,
-not the hash or the #issue-number).
+These "trailers" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons `:`. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number).
 
-We do not enforce a line length on commit messages summary and body,
-but please avoid very long summaries, and very long lines in the body,
-unless they are part of code blocks that must not be wrapped.
+We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
 
 ## Pull requests guidelines
 
@@ -146,5 +119,4 @@ And force-push:
 git push -f
 ```
 
-If this seems all too complicated, you can push or force-push each new commit,
-and we will squash them ourselves if needed, before merging.
+If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.

{shellman-1.0.1 → shellman-1.0.2}/PKG-INFO

@@ -1,9 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: shellman
-Version: 1.0.1
+Version: 1.0.2
 Summary: Write documentation in comments and render it with templates.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
-License: ISC
+License-Expression: ISC
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
@@ -30,6 +31,7 @@ Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.9
 Requires-Dist: jinja2>=3
 Requires-Dist: importlib-metadata>=4.6; python_version < "3.10"
+Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown
 
 <p align="center">

{shellman-1.0.1 → shellman-1.0.2}/config/ruff.toml

@@ -47,17 +47,24 @@ ignore = [
 ]
 
 [lint.per-file-ignores]
-"src/*/cli.py" = [
+"src/**/cli.py" = [
     "T201",  # Print statement
 ]
 "src/*/debug.py" = [
     "T201",  # Print statement
 ]
+"!src/*/*.py" = [
+    "D100",  # Missing docstring in public module
+]
+"!src/**.py" = [
+    "D101",  # Missing docstring in public class
+    "D103",  # Missing docstring in public function
+]
 "scripts/*.py" = [
     "INP001",  # File is part of an implicit namespace package
     "T201",  # Print statement
 ]
-"tests/*.py" = [
+"tests/**.py" = [
     "ARG005",  # Unused lambda argument
     "FBT001",  # Boolean positional arg in function definition
     "PLR2004",  # Magic value used in comparison

{shellman-1.0.1 → shellman-1.0.2}/config/vscode/launch.json

@@ -7,7 +7,17 @@
             "request": "launch",
             "program": "${file}",
             "console": "integratedTerminal",
-            "justMyCode": false
+            "justMyCode": false,
+            "args": "${command:pickArgs}"
+        },
+        {
+            "name": "run",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "shellman",
+            "console": "integratedTerminal",
+            "justMyCode": false,
+            "args": "${command:pickArgs}"
         },
         {
             "name": "docs",

{shellman-1.0.1 → shellman-1.0.2}/docs/.overrides/partials/comments.html

@@ -31,7 +31,7 @@
                 : "light"
 
             // Instruct Giscus to set theme
-            giscus.setAttribute("data-theme", theme) 
+            giscus.setAttribute("data-theme", theme)
         }
 
         // Register event handlers after documented loaded

shellman-1.0.2/docs/.overrides/partials/path-item.html

@@ -0,0 +1,22 @@
+{# Fix breadcrumbs for when mkdocs-section-index is used. #}
+{# See https://github.com/squidfunk/mkdocs-material/issues/7614. #}
+
+<!-- Render navigation link content -->
+{% macro render_content(nav_item) %}
+  <span class="md-ellipsis">
+    {{ nav_item.title }}
+  </span>
+{% endmacro %}
+
+<!-- Render navigation item -->
+{% macro render(nav_item, ref=nav_item) %}
+  {% if nav_item.is_page %}
+    <li class="md-path__item">
+      <a href="{{ nav_item.url | url }}" class="md-path__link">
+        {{ render_content(ref) }}
+      </a>
+    </li>
+  {% elif nav_item.children %}
+    {{ render(nav_item.children | first, ref) }}
+  {% endif %}
+{% endmacro %}

shellman-1.0.2/docs/changelog.md

@@ -0,0 +1,5 @@
+---
+title: Changelog
+---
+
+--8<-- "CHANGELOG.md"

shellman-1.0.2/docs/code_of_conduct.md

@@ -0,0 +1,5 @@
+---
+title: Code of Conduct
+---
+
+--8<-- "CODE_OF_CONDUCT.md"

shellman-1.0.2/docs/contributing.md

@@ -0,0 +1,5 @@
+---
+title: Contributing
+---
+
+--8<-- "CONTRIBUTING.md"

{shellman-1.0.1 → shellman-1.0.2}/docs/credits.md

@@ -1,10 +1,9 @@
 ---
+title: Credits
 hide:
 - toc
 ---
 
-<!-- blacken-docs:off -->
 ```python exec="yes"
 --8<-- "scripts/gen_credits.py"
 ```
-<!-- blacken-docs:on -->

shellman-1.0.2/docs/css/mkdocstrings.css

@@ -0,0 +1,72 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: .05rem solid var(--md-typeset-table-color);
+}
+
+/* Mark external links as such. */
+a.external::after,
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+
+  height: 1em;
+  width: 1em;
+  background-color: currentColor;
+}
+
+a.external:hover::after,
+a.autorefs-external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}
+
+/* Tree-like output for backlinks. */
+.doc-backlink-list {
+  --tree-clr: var(--md-default-fg-color);
+  --tree-font-size: 1rem;
+  --tree-item-height: 1;
+  --tree-offset: 1rem;
+  --tree-thickness: 1px;
+  --tree-style: solid;
+  display: grid;
+  list-style: none !important;
+}
+
+.doc-backlink-list li > span:first-child {
+  text-indent: .3rem;
+}
+.doc-backlink-list li {
+  padding-inline-start: var(--tree-offset);
+  border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
+  position: relative;
+  margin-left: 0 !important;
+
+  &:last-child {
+    border-color: transparent;
+  }
+  &::before{
+    content: '';
+    position: absolute;
+    top: calc(var(--tree-item-height) / 2 * -1 * var(--tree-font-size) + var(--tree-thickness));
+    left: calc(var(--tree-thickness) * -1);
+    width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
+    height: calc(var(--tree-item-height)  * var(--tree-font-size));
+    border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
+    border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
+  }
+  &::after{
+    content: '';
+    position: absolute;
+    border-radius: 50%;
+    background-color: var(--tree-clr);
+    top: calc(var(--tree-item-height) / 2 * 1rem);
+    left: var(--tree-offset) ;
+    translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
+  }
+}

{shellman-1.0.1 → shellman-1.0.2}/docs/index.md

@@ -1,4 +1,5 @@
 ---
+title: Overview
 hide:
 - feedback
 ---

{shellman-1.0.1 → shellman-1.0.2}/docs/license.md

@@ -1,4 +1,5 @@
 ---
+title: License
 hide:
 - feedback
 ---

shellman-1.0.2/docs/reference/api.md

@@ -0,0 +1,9 @@
+---
+title: API reference
+hide:
+- navigation
+---
+
+# ::: shellman
+    options:
+        show_submodules: true

{shellman-1.0.1 → shellman-1.0.2}/duties.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import os
+import re
 import sys
 from contextlib import contextmanager
 from importlib.metadata import version as pkgversion
@@ -26,7 +27,7 @@ PTY = not WINDOWS and not CI
 MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
 
 
-def pyprefix(title: str) -> str:  # noqa: D103
+def pyprefix(title: str) -> str:
     if MULTIRUN:
         prefix = f"(python{sys.version_info.major}.{sys.version_info.minor})"
         return f"{prefix:14}{title}"
@@ -34,7 +35,7 @@ def pyprefix(title: str) -> str:  # noqa: D103
 
 
 @contextmanager
-def material_insiders() -> Iterator[bool]:  # noqa: D103
+def material_insiders() -> Iterator[bool]:
     if "+insiders" in pkgversion("mkdocs-material"):
         os.environ["MATERIAL_INSIDERS"] = "true"
         try:
@@ -45,6 +46,12 @@ def material_insiders() -> Iterator[bool]:  # noqa: D103
         yield False
 
 
+def _get_changelog_version() -> str:
+    changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
+    with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
+        return next(filter(bool, map(changelog_version_re.match, file))).group(1)  # type: ignore[union-attr]
+
+
 @duty
 def changelog(ctx: Context, bump: str = "") -> None:
     """Update the changelog in-place with latest commits.
@@ -53,6 +60,7 @@ def changelog(ctx: Context, bump: str = "") -> None:
         bump: Bump option passed to git-changelog.
     """
     ctx.run(tools.git_changelog(bump=bump or None), title="Updating changelog")
+    ctx.run(tools.yore.check(bump=bump or _get_changelog_version()), title="Checking legacy code")
 
 
 @duty(pre=["check-quality", "check-types", "check-docs", "check-api"])
@@ -84,6 +92,7 @@ def check_docs(ctx: Context) -> None:
 @duty
 def check_types(ctx: Context) -> None:
     """Check that the code is correctly typed."""
+    os.environ["FORCE_COLOR"] = "1"
     ctx.run(
         tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"),
         title=pyprefix("Type-checking"),

{shellman-1.0.1 → shellman-1.0.2}/mkdocs.yml

@@ -20,14 +20,12 @@ nav:
   - Credits: credits.md
   - License: license.md
   - Todo: todo.md
-- Usage: 
+- Usage:
   - usage/index.md
   - Syntax: usage/syntax.md
   - Tags: usage/tags.md
   - Plugins: usage/plugins.md
-# defer to gen-files + literate-nav
-- API reference:
-  - shellman: reference/
+- API reference: reference/api.md
 - Development:
   - Contributing: contributing.md
   - Code of Conduct: code_of_conduct.md
@@ -47,7 +45,8 @@ theme:
   - content.code.copy
   - content.tooltips
   - navigation.footer
-  - navigation.indexes
+  - navigation.instant.preview
+  - navigation.path
   - navigation.sections
   - navigation.tabs
   - navigation.tabs.sticky
@@ -107,24 +106,24 @@ markdown_extensions:
 
 plugins:
 - search
+- autorefs
 - markdown-exec
-- gen-files:
-    scripts:
-    - scripts/gen_ref_nav.py
-- literate-nav:
-    nav_file: SUMMARY.md
+- section-index
 - coverage
 - mkdocstrings:
     handlers:
       python:
-        import:
+        inventories:
         - https://docs.python.org/3/objects.inv
         paths: [src]
         options:
+          backlinks: tree
           docstring_options:
             ignore_init_summary: true
           docstring_section_style: list
-          filters: ["!^_"]
+          extensions:
+          - griffe_inherited_docstrings
+          filters: public
           heading_level: 1
           inherited_members: true
           merge_init_into_class: true
@@ -137,6 +136,12 @@ plugins:
           show_symbol_type_toc: true
           signature_crossrefs: true
           summary: true
+- llmstxt:
+    files:
+    - output: llms-full.txt
+      inputs:
+      - index.md
+      - reference/**.md
 - git-revision-date-localized:
     enabled: !ENV [DEPLOY, false]
     enable_creation_date: true