shellman 1.0.2__tar.gz → 1.0.3__tar.gz

shellman-1.0.3/AI_POLICY.md

@@ -0,0 +1,15 @@
+# AI Contribution Policy
+
+We accept AI-*assisted* contributions, both for code and documentation, with the following expectations:
+
+- AI-assisted contributions must disclaim their use of AI.
+- Contributors must fully understand the proposed changes and be able to explain why they are the correct approach.
+- Issues must be created before creating pull requests (unless there is already a relevant issue).
+- Issue and pull request templates must be followed.
+- Comments (including bodies) in issues and pull requests must be written by humans. If you use LLMs to translate from one language to another, please include your original comment and the translated one.
+- Git commits must be authored by humans, not AI/bot accounts or identities.
+- Git commit messages must be written by humans, in English. If you cannot write English, please state so in the pull request body and we will write the commit messages ourselves.
+
+Failure to comply with any of these requirements will result in issues or pull requests being closed immediately without comment. Repeated violations of this policy will result in a ban of the offending accounts/identities from contributing to this project and any related project from the same author/organization.
+
+We do not accept AI-generated content in community spaces we maintain or moderate, such as GitHub discussions or Matrix rooms.

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

@@ -6,6 +6,14 @@ 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.3](https://github.com/pawamoy/shellman/releases/tag/1.0.3) - 2026-10-06
+
+<small>[Compare with 1.0.2](https://github.com/pawamoy/shellman/compare/1.0.2...1.0.3)</small>
+
+### Build
+
+- Drop support for Python 3.10 ([3a653d9](https://github.com/pawamoy/shellman/commit/3a653d9675b7b4744c31166fba0a8eda1bdf0ebf) by Timothée Mazzucotelli).
+
 ## [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>

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

@@ -1,28 +1,19 @@
 # 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
+**Please always create an issue before working on a new feature or a bug fix, so that we can discuss the implementation and make sure that your work will be merged.**
 
-Nothing easier!
+## Environment setup
 
-Fork and clone the repository, then:
+Install [uv](https://github.com/astral-sh/uv) and [direnv](https://direnv.net/), fork and clone the repository, then:
 
 ```bash
 cd shellman
+direnv allow
 make setup
 ```
 
-> 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:
->
-> ```bash
-> curl -LsSf https://astral.sh/uv/install.sh | sh
-> ```
->
-> Now you can try running `make setup` again, or simply `uv sync`.
-
 You now have the dependencies installed.
 
 You can run the application with `make run shellman [ARGS...]`.
@@ -31,8 +22,7 @@ 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.
 

{shellman-1.0.2 → shellman-1.0.3}/LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2020, Timothée Mazzucotelli
+Copyright (c) 2020, Timothée Mazzucotelli and contributors
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: shellman
-Version: 1.0.2
+Version: 1.0.3
 Summary: Write documentation in comments and render it with templates.
-Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
 License-Expression: ISC
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
@@ -10,12 +10,11 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development
 Classifier: Topic :: Utilities
@@ -28,10 +27,8 @@ Project-URL: Issues, https://github.com/pawamoy/shellman/issues
 Project-URL: Discussions, https://github.com/pawamoy/shellman/discussions
 Project-URL: Gitter, https://gitter.im/shellman/community
 Project-URL: Funding, https://github.com/sponsors/pawamoy
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 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.2 → shellman-1.0.3}/config/git-changelog.toml

@@ -4,6 +4,6 @@ in-place = true
 output = "CHANGELOG.md"
 parse-refs = false
 parse-trailers = true
-sections = ["build", "deps", "feat", "fix", "refactor"]
+sections = ["build", "deps", "feat", "fix", "perf", "refactor"]
 template = "keepachangelog"
 versioning = "pep440"

{shellman-1.0.2 → shellman-1.0.3}/config/pytest.ini

@@ -10,5 +10,7 @@ testpaths =
 # action:message_regex:warning_class:module_regex:line
 filterwarnings =
   error
+  default::EncodingWarning
+  error::EncodingWarning:shellman
   # TODO: remove once pytest-xdist 4 is released
   ignore:.*rsyncdir:DeprecationWarning:xdist

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

@@ -1,34 +1,14 @@
-target-version = "py39"
+target-version = "py311"
 line-length = 120
+output-format = "concise"
 
 [lint]
 exclude = [
     "tests/fixtures/*.py",
 ]
-select = [
-    "A", "ANN", "ARG",
-    "B", "BLE",
-    "C", "C4",
-    "COM",
-    "D", "DTZ",
-    "E", "ERA", "EXE",
-    "F", "FBT",
-    "G",
-    "I", "ICN", "INP", "ISC",
-    "N",
-    "PGH", "PIE", "PL", "PLC", "PLE", "PLR", "PLW", "PT", "PYI",
-    "Q",
-    "RUF", "RSE", "RET",
-    "S", "SIM", "SLF",
-    "T", "T10", "T20", "TCH", "TID", "TRY",
-    "UP",
-    "W",
-    "YTT",
-]
+select = ["ALL"]
 ignore = [
     "A001",  # Variable is shadowing a Python builtin
-    "ANN101",  # Missing type annotation for self
-    "ANN102",  # Missing type annotation for cls
     "ANN204",  # Missing return type annotation for special method __str__
     "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed
     "ARG005",  # Unused lambda argument
@@ -36,13 +16,18 @@ ignore = [
     "D105",  # Missing docstring in magic method
     "D417",  # Missing argument description in the docstring
     "E501",  # Line too long
+    "EM101",  # String literal when raising exception
+    "EM102",  # f-string when raising exception
     "ERA001",  # Commented out code
+    "FIX",  # TODO, FIXME, etc.
     "G004",  # Logging statement uses f-string
     "PLR0911",  # Too many return statements
     "PLR0912",  # Too many branches
     "PLR0913",  # Too many arguments to function call
     "PLR0915",  # Too many statements
     "SLF001", # Private member accessed
+    "TD002",  # Missing author in TODO
+    "TD003",  # Missing issue link for TODO
     "TRY003",  # Avoid specifying long messages outside the exception class
 ]
 

shellman-1.0.3/config/ty.toml

@@ -0,0 +1,6 @@
+[src]
+exclude = ["tests/fixtures"]
+
+[terminal]
+error-on-warning = true
+output-format = "concise"

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

@@ -23,11 +23,10 @@
             "name": "docs",
             "type": "debugpy",
             "request": "launch",
-            "module": "mkdocs",
+            "module": "zensical",
             "justMyCode": false,
             "args": [
                 "serve",
-                "-v"
             ]
         },
         {

{shellman-1.0.2 → shellman-1.0.3}/config/vscode/settings.json

@@ -4,9 +4,6 @@
         "**/.venvs*/**": true,
         "**/venv*/**": true
     },
-    "mypy-type-checker.args": [
-        "--config-file=config/mypy.ini"
-    ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
@@ -19,6 +16,7 @@
     "ruff.lint.args": [
         "--config=config/ruff.toml"
     ],
+    "ty.configurationFile": "config/ty.toml",
     "yaml.schemas": {
         "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
     },

shellman-1.0.3/config/zed/debug.json

@@ -0,0 +1,44 @@
+// Project-local debug tasks
+//
+// For more documentation on how to configure debug tasks,
+// see: https://zed.dev/docs/debugger
+[
+  {
+    "label": "python (current file)",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "program": "$ZED_FILE",
+    "justMyCode": false
+  },
+  {
+    "label": "run",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "module": "shellman",
+    "justMyCode": false
+  },
+  {
+    "label": "docs",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "module": "zensical",
+    "args": [
+      "serve"
+    ],
+    "justMyCode": false
+  },
+  {
+    "label": "test",
+    "adapter": "Debugpy",
+    "request": "launch",
+    "module": "pytest",
+    "args": [
+      "-c=config/pytest.ini",
+      "-vvv",
+      "--no-cov",
+      "--dist=no",
+      "tests"
+    ],
+    "justMyCode": false
+  }
+]

shellman-1.0.3/config/zed/settings.json

@@ -0,0 +1,43 @@
+// Zed settings
+//
+// For information on how to configure Zed, see the Zed
+// documentation: https://zed.dev/docs/configuring-zed
+//
+// To see all of Zed's default settings without changing your
+// custom settings, run `zed: open default settings` from the
+// command palette (cmd-shift-p / ctrl-shift-p)
+{
+  "languages": {
+    "YAML": {
+      "auto_indent_on_paste": false,
+      "auto_indent": "preserve_indent",
+      "format_on_save": "off"
+    },
+    "Python": {
+      "language_servers": ["ty", "ruff"],
+      "code_actions_on_format": {
+        "source.organizeImports.ruff": true
+      },
+      "formatter": {
+        "language_server": {
+          "name": "ruff"
+        }
+      }
+    }
+  },
+  "lsp": {
+    "ty": {
+      "settings": {
+        "configurationFile": "config/ty.toml"
+      }
+    },
+    "ruff": {
+      "initialization_options": {
+        "settings": {
+          "configurationPreference": "filesystemFirst",
+          "configuration": "config/ruff.toml"
+        }
+      }
+    }
+  }
+}

shellman-1.0.3/config/zed/tasks.json

@@ -0,0 +1,72 @@
+[
+  {
+    "label": "changelog",
+    "command": "scripts/make",
+    "args": ["changelog"]
+  },
+  {
+    "label": "check",
+    "command": "scripts/make",
+    "args": ["check"]
+  },
+  {
+    "label": "check-quality",
+    "command": "scripts/make",
+    "args": ["check-quality"]
+  },
+  {
+    "label": "check-types",
+    "command": "scripts/make",
+    "args": ["check-types"]
+  },
+  {
+    "label": "check-docs",
+    "command": "scripts/make",
+    "args": ["check-docs"]
+  },
+  {
+    "label": "check-api",
+    "command": "scripts/make",
+    "args": ["check-api"]
+  },
+  {
+    "label": "clean",
+    "command": "scripts/make",
+    "args": ["clean"]
+  },
+  {
+    "label": "docs",
+    "command": "scripts/make",
+    "args": ["docs"]
+  },
+  {
+    "label": "docs-deploy",
+    "command": "scripts/make",
+    "args": ["docs-deploy"]
+  },
+  {
+    "label": "format",
+    "command": "scripts/make",
+    "args": ["format"]
+  },
+  {
+    "label": "release",
+    "command": "scripts/make",
+    "args": ["release"]
+  },
+  {
+    "label": "setup",
+    "command": "scripts/make",
+    "args": ["setup"]
+  },
+  {
+    "label": "test",
+    "command": "scripts/make",
+    "args": ["test", "coverage"]
+  },
+  {
+    "label": "vscode",
+    "command": "scripts/make",
+    "args": ["vscode"]
+  }
+]

{shellman-1.0.2 → shellman-1.0.3}/docs/.overrides/main.html

@@ -1,7 +1,11 @@
 {% extends "base.html" %}
 
 {% block announce %}
-  
+  <strong>Fund this project</strong> through
+  <a href="https://github.com/sponsors/pawamoy"><strong>sponsorship</strong></a>
+  <span class="twemoji heart pulse">
+    {% include ".icons/octicons/heart-fill-16.svg" %}
+  </span> &mdash;
   Follow
   <strong>@pawamoy</strong> on
   <a rel="me" href="https://fosstodon.org/@pawamoy">

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

@@ -1,5 +1,5 @@
 <!-- Giscus -->
-<!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration -->
+<!-- https://zensical.org/docs/setup/comment-system/#giscus-integration -->
 <div id="feedback" style="display: none;">
     <h2 id="__comments">Feedback</h2>
     <script src="https://giscus.app/client.js"

shellman-1.0.3/docs/css/apidocs.css

@@ -0,0 +1,21 @@
+/* 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);
+}