shellman 0.4.1__tar.gz → 1.0.1__tar.gz

shellman-1.0.1/CHANGELOG.md

@@ -0,0 +1,220 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+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.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>
+
+### Build
+
+- Drop support for Python 3.8 ([3675ff8](https://github.com/pawamoy/shellman/commit/3675ff8649f3925c60714e20e114e63e3230cc2c) by Timothée Mazzucotelli).
+
+### Bug Fixes
+
+- Add missing rendering of functions stdin/stdout/stderr ([d7fc017](https://github.com/pawamoy/shellman/commit/d7fc0177396858f5078c58f25ceedc849053fc5d) by Timothée Mazzucotelli). [Issue-37](https://github.com/pawamoy/shellman/issues/37)
+
+## [1.0.0](https://github.com/pawamoy/shellman/releases/tag/1.0.0) - 2023-09-03
+
+<small>[Compare with 0.4.1](https://github.com/pawamoy/shellman/compare/0.4.1...1.0.0)</small>
+
+It has been a long time since the last release, and the last time I worked on this project.
+I've updated the project with my latest template. Support for Python 2 is dropped.
+I took the opportunity to privatize most of the API. I'll see in a later version
+if there is a need to expose a main `parse` function or similar, to extract
+information from a given file.
+
+### Breaking Changes
+
+- `shellman.reader.DocLine.doc_type`: Public object points to a different kind of object: function -> attribute
+- `shellman.reader.preprocess_stream`: Public object was removed
+- `shellman.reader.preprocess_lines`: Public object was removed
+- `shellman.reader.process_blocks`: Public object was removed
+- `shellman.reader.merge`: Public object was removed
+- `shellman.context.get_cli_context`: Public object was removed
+- `shellman.context.get_env_context`: Public object was removed
+- `shellman.context.get_file_context`: Public object was removed
+- `shellman.context.get_context`: Public object was removed
+- `shellman.context.update`: Public object was removed
+- `shellman.cli.get_context`: Public object was removed
+- `shellman.cli.update`: Public object was removed
+- `shellman.cli.merge`: Public object was removed
+- `shellman.cli.valid_file`: Public object was removed
+- `shellman.cli.render`: Public object was removed
+- `shellman.cli.write`: Public object was removed
+- `shellman.cli.common_ancestor`: Public object was removed
+- `shellman.cli.is_format_string`: Public object was removed
+- `shellman.cli.guess_filename`: Public object was removed
+- `shellman.cli.output_name_variables`: Public object was removed
+- `shellman.cli.get_vcs_root`: Public object was removed
+- `shellman.cli.main(argv)`: Parameter was removed
+- `shellman.templates.get_builtin_path`: Public object was removed
+- `shellman.templates.get_env`: Public object was removed
+- `shellman.templates.get_custom_template`: Public object was removed
+- `shellman.templates.load_plugin_templates`: Public object was removed
+- `shellman.templates.names`: Public object was removed
+- `shellman.templates.parser_choices`: Public object was removed
+- `shellman.templates.filters.do_groffauto(escape)`: Parameter kind was changed: positional or keyword -> keyword-only
+- `shellman.templates.filters.do_smartwrap(indentfirst)`: Parameter kind was changed: positional or keyword -> keyword-only
+- `shellman.templates.filters.do_format(string)`: Parameter was added as required
+- `shellman.templates.filters.do_groupby(sort)`: Parameter kind was changed: positional or keyword -> keyword-only
+
+### Bug Fixes
+
+- Update for Python 3 and new versions of dependencies ([e16c46f](https://github.com/pawamoy/shellman/commit/e16c46f0a72c8161d745851182379a53f78f242e) by Timothée Mazzucotelli).
+
+### Code Refactoring
+
+- Rewrite tag classes as dataclasses ([f1780d4](https://github.com/pawamoy/shellman/commit/f1780d473ae9a25b52e49614cfc8a866024bcaf7) by Timothée Mazzucotelli).
+
+## [0.4.1](https://github.com/pawamoy/shellman/tags/0.4.1) - 2018-10-10
+
+<small>[Compare with 0.4.0](https://github.com/pawamoy/shellman/compare/0.4.0...0.4.1)</small>
+
+### Fixed
+- Fix `body` filter for Python 2 ([ce7d0ef](https://github.com/pawamoy/shellman/commit/ce7d0ef1a4b6f7365580d06ff064504c38247d01)).
+
+## [0.4.0](https://github.com/pawamoy/shellman/tags/0.4.0) - 2018-09-28
+
+<small>[Compare with 0.3.4](https://github.com/pawamoy/shellman/compare/0.3.4...0.4.0)</small>
+
+### Added
+- Add context variable to avoid escaping lines starting with given values ([742e023](https://github.com/pawamoy/shellman/commit/742e02321de656e80944d627a6cf727cbc6e66e0)).
+- Add usagetext template ([a7c20fc](https://github.com/pawamoy/shellman/commit/a7c20fc751990c229018fc1b6c01835f9da5c193)).
+
+### Fixed
+- Fix escape filter condition ([f32cd43](https://github.com/pawamoy/shellman/commit/f32cd43a0b4d88f841e7e5fee9633f7f772637e8)).
+- Fix python 2 unicode decode error ([0040028](https://github.com/pawamoy/shellman/commit/0040028f245586bbdffe62b14218abc31539dc85)).
+- Fix variables for output ([01155fb](https://github.com/pawamoy/shellman/commit/01155fbf3fcb4c1beb3ad867a428783ae647af57)).
+
+### Misc
+- Improve error messages ([96ebb68](https://github.com/pawamoy/shellman/commit/96ebb68c01b7b132666bb900d7f20f2f1c296d65)).
+
+## [0.3.4](https://github.com/pawamoy/shellman/tags/0.3.4) - 2018-09-22
+
+<small>[Compare with 0.3.3](https://github.com/pawamoy/shellman/compare/0.3.3...0.3.4)</small>
+
+### Fixed
+- Fix writing UTF-8 contents to file for Python 2 ([9e99b23](https://github.com/pawamoy/shellman/commit/9e99b232d2c1171c9e3ee3b20f0f788b82d1d634)).
+
+### Misc
+- Improve credits line ([f7a7cae](https://github.com/pawamoy/shellman/commit/f7a7cae8e1bf7363a73c127b542584e348dfae5c)).
+
+## [0.3.3](https://github.com/pawamoy/shellman/tags/0.3.3) - 2018-09-18
+
+<small>[Compare with 0.3.2](https://github.com/pawamoy/shellman/compare/0.3.2...0.3.3)</small>
+
+### Fixed
+- Fix manifest (missing setup.py) ([62ccfaf](https://github.com/pawamoy/shellman/commit/62ccfaf90c4bd301c625101763462bc0c5374567)).
+
+## [0.3.2](https://github.com/pawamoy/shellman/tags/0.3.2) - 2018-09-18
+
+<small>[Compare with 0.3.1](https://github.com/pawamoy/shellman/compare/0.3.1...0.3.2)</small>
+
+### Misc
+- Add logo and demo.svg to fix PyPI page ([1e06662](https://github.com/pawamoy/shellman/commit/1e066626e7bcfb919e4d0ce4508b9305a962551a)).
+
+## [0.3.1](https://github.com/pawamoy/shellman/tags/0.3.1) - 2018-09-18
+
+<small>[Compare with 0.3.0](https://github.com/pawamoy/shellman/compare/0.3.0...0.3.1)</small>
+
+### Misc
+- Reduce size of package, simplify manifest ([f123b53](https://github.com/pawamoy/shellman/commit/f123b53fc973e05db36f5370d48647d56c571dcf)).
+- Switch documents to markdown ([f3917e9](https://github.com/pawamoy/shellman/commit/f3917e9c46566898681e075bbc45afb7151e015f)).
+
+## [0.3.0](https://github.com/pawamoy/shellman/tags/0.3.0) - 2018-09-17
+
+<small>[Compare with 0.2.2](https://github.com/pawamoy/shellman/compare/0.2.2...0.3.0)</small>
+
+### Added
+- Add credits in wikipage template ([e70b7c8](https://github.com/pawamoy/shellman/commit/e70b7c8fa4acef2acf1bd7a0dfd96383ef50fec4)).
+- Add groupby_unsorted filter to improve option rendering ([2e42177](https://github.com/pawamoy/shellman/commit/2e421776319e8422ddf3191c98666e4c43e1ae16)).
+- Add logo ([f9289a0](https://github.com/pawamoy/shellman/commit/f9289a0edbdc53ea16bfbc07bf4ac873ae8548f0)).
+- Add new reader module ([ea13cfb](https://github.com/pawamoy/shellman/commit/ea13cfb4a31f9cee2f1a108fd9e1103cb5afda28)).
+- Add option to smart_width to indent first line or not ([e625afb](https://github.com/pawamoy/shellman/commit/e625afbe1ba9a851bed40e4792d6fcd0e9fafab1)).
+- Add vcsroot name variable ([f5db3b3](https://github.com/pawamoy/shellman/commit/f5db3b35f953a82eba64fc375e4f4638457b1e03)).
+
+### Changed
+- Change README.rst to README.md ([4628e76](https://github.com/pawamoy/shellman/commit/4628e76bce717ea3ab47b7f29114caa7e1d50084)).
+
+### Fixed
+- Fix code block ([de304ee](https://github.com/pawamoy/shellman/commit/de304eeb56ae2d3431ab6c5db9fdca7100ee2dbd)).
+- Fix credits and readme url to gitlab plugins doc ([9958019](https://github.com/pawamoy/shellman/commit/9958019791d981ea566a1973c4f8aa47ae2d5ac2)).
+- Fix get context from env ([f1e2296](https://github.com/pawamoy/shellman/commit/f1e2296646ecf523c559e7db3bdcd14779dd01fd)).
+- Fix usage tag ([4a47431](https://github.com/pawamoy/shellman/commit/4a474311f748f70a07fceb8acfbabdaba634b3eb)).
+- Fix wikipage template ([2f5a0ad](https://github.com/pawamoy/shellman/commit/2f5a0adf3ec8a28c242d1bcad426030fda9ac224)).
+
+### Removed
+- Remove blank line in AUTHORS ([e414282](https://github.com/pawamoy/shellman/commit/e414282316518aa2a5f8895433f576d659720195)).
+- Remove formatter options, enforce user behavior ([48c26d0](https://github.com/pawamoy/shellman/commit/48c26d03e328272b1001134c86be6d79e1736a90)).
+- Remove MPL2.0 notices in sources (now ISC) ([87e92df](https://github.com/pawamoy/shellman/commit/87e92df8b9577968db090ac00bada17086368574)).
+- Remove pyup file, remove option-description subtag (implicit) ([4a08fa1](https://github.com/pawamoy/shellman/commit/4a08fa1e42f5972cf462419f7869db6f9a5aafd9)).
+
+### Misc
+- Allow failure for style and spell on travis ([4a7a60f](https://github.com/pawamoy/shellman/commit/4a7a60f208dcd654b7f9618b0157ffa584be3bea)).
+- Automatically compute indent_str from indent, cast indent to int ([0a09554](https://github.com/pawamoy/shellman/commit/0a0955499450aa5c4069b5fafc38abc0db409094)).
+- Handle multiple file input/output, fix some templates vars, format with black ([2c6672b](https://github.com/pawamoy/shellman/commit/2c6672b47b04082865528e6028dd1fd3645c7058)).
+- Ignore bandit warning as irrelevant (no html templates) ([4947fe5](https://github.com/pawamoy/shellman/commit/4947fe59d912a954e775944f40da2be94dc095da)).
+- Implement context abilities ([5e7c9d4](https://github.com/pawamoy/shellman/commit/5e7c9d4bcc3ddc52caca079a625a927959853843)).
+- Implement plugin abilities ([cd4723f](https://github.com/pawamoy/shellman/commit/cd4723f84771d2d5f60fd0dc047d597b708a1c31)).
+- Implement smart_width for text format, write more templates ([bb15f51](https://github.com/pawamoy/shellman/commit/bb15f518085c903033b8f9c007c67aba97db03da)).
+- Improve helptext usage display, fix smartwrap indent ([11f78bf](https://github.com/pawamoy/shellman/commit/11f78bfcfb043fadc943ac60147293d74c6088d9)).
+- Improve manpage groff template, fix various issues ([b829593](https://github.com/pawamoy/shellman/commit/b82959337e7f3c6801533c02976e74f55e268ff9)).
+- Link up with argparse ([12f186d](https://github.com/pawamoy/shellman/commit/12f186dd1905f270fc095ff1539d0416d8911afc)).
+- Rename tag to section ([5e80735](https://github.com/pawamoy/shellman/commit/5e80735f7f23c2dc9ca63dca94286f0a8763272b)).
+- Update demo script and svg ([ec0c282](https://github.com/pawamoy/shellman/commit/ec0c282b282cf23fc97b2767928109d19df37f6d)).
+- Update docs, simplify context usage ([8c6c950](https://github.com/pawamoy/shellman/commit/8c6c950f14f2b3f8502e16f2e9ff0fe209b00259)).
+- Use GitLab-CI instead of Travis ([de662d0](https://github.com/pawamoy/shellman/commit/de662d03c8b4ee7cb4a35c2b1909da6415de597d)).
+
+
+## [0.2.2](https://github.com/pawamoy/shellman/tags/0.2.2) - 2017-05-02
+
+<small>[Compare with 0.2.1](https://github.com/pawamoy/shellman/compare/0.2.1...0.2.2)</small>
+
+### Changed
+- Change license from MPL 2.0 to ISC (no 'same license' condition) ([868b89e](https://github.com/pawamoy/shellman/commit/868b89ee7df7af36fdc3e4ce424a241867e89c24)).
+
+### Fixed
+- Fix cli main return None -> 0 ([7beeecc](https://github.com/pawamoy/shellman/commit/7beeeccb559606bb2b338f2426fb3f5b91f840e7)).
+- Fix codacy badge ([fe55efb](https://github.com/pawamoy/shellman/commit/fe55efbd2cd205df1f9b1ce8b02f2dd2d101ba6e)).
+- Fix docs spelling ([69988a2](https://github.com/pawamoy/shellman/commit/69988a2e70e18108525ce6bf412cb743441b3516)).
+- Fix installation instruction (--user does not install entry point...) ([aa2037b](https://github.com/pawamoy/shellman/commit/aa2037b627ce2e6e2fb1b83fa1fb0669545756ec)).
+- Fix man synopsis section ([d79db9a](https://github.com/pawamoy/shellman/commit/d79db9a2c0e361374b1d8e8e376d95599605e9a0)).
+
+### Misc
+- Begin to fix output option ([f1e5488](https://github.com/pawamoy/shellman/commit/f1e5488f997a065d26c5f20d00afd7efe93e234d)).
+- Hide sphinx warnings, travis install enchant ([c216c78](https://github.com/pawamoy/shellman/commit/c216c780a3502b795bf96a3269f263aeac2c1a08)).
+- Use codacy instead of codecov ([c024b1c](https://github.com/pawamoy/shellman/commit/c024b1ce8bfaf0aa7f0d71378d528cebd8e96c46)).
+
+
+## [0.2.1](https://github.com/pawamoy/shellman/tags/0.2.1) - 2016-12-06
+
+<small>[Compare with 0.2.0](https://github.com/pawamoy/shellman/compare/0.2.0...0.2.1)</small>
+
+### Misc
+- Update README, fix help display ([a131b82](https://github.com/pawamoy/shellman/commit/a131b82d84d68e4dfa5211cdc5dd26c930fa33c1)).
+
+
+## [0.2.0](https://github.com/pawamoy/shellman/tags/0.2.0) - 2016-12-06
+
+<small>[Compare with first commit](https://github.com/pawamoy/shellman/compare/7c77c2bda82a2808aacc4500e01b33f082325ec5...0.2.0)</small>
+
+### Added
+- Add check feature, add tests ([4916b51](https://github.com/pawamoy/shellman/commit/4916b514b85fcf6a87a81fe0d3ac6ed4f8bc1011)).
+- Add demo example ([ec78d6b](https://github.com/pawamoy/shellman/commit/ec78d6bc2c238c02685e260494be37a510d0f015)).
+- Add markdown format, improve python3 compatibility, add gitignore ([6b8c295](https://github.com/pawamoy/shellman/commit/6b8c2959e340bd999177b99c4f1a70286a19aaab)).
+- Add tests ([4d08087](https://github.com/pawamoy/shellman/commit/4d080877799e33fba2b8a5ee0133257763ac80c2)).
+
+### Fixed
+- Fix changing release date over upstream update ([11738c4](https://github.com/pawamoy/shellman/commit/11738c4484efae0535aa97abd77911752d8d4f47)).
+- Fix command line usage and tests usage combination ([bcef7c9](https://github.com/pawamoy/shellman/commit/bcef7c9b5413584c740de2c028f0786e3c8ef48a)).
+- Fix dangerous warning about sys.argv as default value ([effe263](https://github.com/pawamoy/shellman/commit/effe26350d8a0516a890c265b195089f83a7fda0)).
+
+### Misc
+- Implement new structure ([40b4806](https://github.com/pawamoy/shellman/commit/40b48063b02b5cae1c7074f0921b411fb2aed9f6)).
+- Setup tests ([5d50692](https://github.com/pawamoy/shellman/commit/5d50692ab5c49644039eab74d467335fded253c0)).
+- Write doc ([1a8e0e4](https://github.com/pawamoy/shellman/commit/1a8e0e4d4624d8ca0eeb66dd78eb3d8b65a11f45)).

shellman-1.0.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+# 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/CONTRIBUTING.md

@@ -0,0 +1,150 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+## Environment setup
+
+Nothing easier!
+
+Fork and clone the repository, then:
+
+```bash
+cd shellman
+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...]`.
+
+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).
+
+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
+
+As usual:
+
+1. create a new branch: `git switch -c feature-or-bugfix-name`
+1. edit the code and/or the documentation
+
+**Before committing:**
+
+1. run `make format` to auto-format the code
+1. run `make check` to check everything (fix any warning)
+1. run `make test` to run the tests (fix any issue)
+1. if you updated the documentation or the project dependencies:
+    1. run `make docs`
+    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.
+
+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):
+
+```
+<type>[(scope)]: Subject
+
+[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.
+
+Scope and body are optional. Type can be:
+
+- `build`: About packaging, building wheels, etc.
+- `chore`: About packaging or repo/files management.
+- `ci`: About Continuous Integration.
+- `deps`: Dependencies update.
+- `docs`: About documentation.
+- `feat`: New feature.
+- `fix`: Bug fix.
+- `perf`: About performance.
+- `refactor`: Changes that are not features or bug fixes.
+- `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:
+
+```
+Body.
+
+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).
+
+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
+
+Link to any related issue in the Pull Request message.
+
+During the review, we recommend using fixups:
+
+```bash
+# SHA is the SHA of the commit you want to fix
+git commit --fixup=SHA
+```
+
+Once all the changes are approved, you can squash your commits:
+
+```bash
+git rebase -i --autosquash main
+```
+
+And force-push:
+
+```bash
+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.

{shellman-0.4.1 → shellman-1.0.1}/LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2017, Timothee Mazzucotelli
+Copyright (c) 2020, Timothée Mazzucotelli
 
 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.1/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.1
+Name: shellman
+Version: 1.0.1
+Summary: Write documentation in comments and render it with templates.
+Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+License: ISC
+Classifier: Development Status :: 4 - Beta
+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: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://pawamoy.github.io/shellman
+Project-URL: Documentation, https://pawamoy.github.io/shellman
+Project-URL: Changelog, https://pawamoy.github.io/shellman/changelog
+Project-URL: Repository, https://github.com/pawamoy/shellman
+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-Dist: jinja2>=3
+Requires-Dist: importlib-metadata>=4.6; python_version < "3.10"
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://rawgit.com/pawamoy/shellman/master/logo.png">
+</p>
+
+<h1 align="center">Shell Script Documentation</h1>
+
+<p align="center">Write documentation in comments and render it with templates.</p>
+
+<p align="center">
+  <a href="https://github.com/pawamoy/shellman/actions?query=workflow%3Aci">
+    <img alt="ci" src="https://github.com/pawamoy/shellman/workflows/ci/badge.svg" />
+  </a>
+  <a href="https://pawamoy.github.io/shellman/">
+    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
+  </a>
+  <a href="https://pypi.org/project/shellman/">
+    <img alt="pypi" src="https://img.shields.io/pypi/v/shellman.svg" />
+  </a>
+  <a href="https://gitpod.io/#https://github.com/pawamoy/shellman">
+    <img alt="gitpod" src="https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat" />
+  </a>
+  <a href="https://gitter.im/shellman/community">
+    <img alt="gitter" src="https://badges.gitter.im/join%20chat.svg" />
+  </a>
+</p>
+
+`shellman` can generate man pages, wiki pages and help text
+using documentation written in shell scripts comments.
+
+For example:
+
+```bash
+#!/bin/bash
+
+## \brief Just a demo
+## \desc This script actually does nothing.
+
+main() {
+  case "$1" in
+    ## \option -h, --help
+    ## Print this help and exit.
+    -h|--help) shellman "$0"; exit 0 ;;
+  esac
+}
+
+## \usage demo [-h]
+main "$@"
+```
+
+Output when calling ``./demo -h``:
+
+```
+Usage: demo [-h]
+
+This script actually does nothing.
+
+Options:
+  -h, --help            Print this help and exit.
+```
+
+You can see more examples in the documentation: https://pawamoy.github.io/shellman/.
+
+<h2 align="center">Demo</h2>
+<p align="center"><img src="https://rawgit.com/pawamoy/shellman/master/demo.svg"></p>
+
+In the demo above we saw the three builtin templates:
+helptext, manpage and wikipage.
+
+You can use your own templates
+by specifying them with the ``--template path:my/template`` syntax.
+
+You can also write a plugin, see the docs: https://pawamoy.github.io/shellman/plugins.
+
+## Installation
+
+```bash
+pip install shellman
+```
+
+With [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install shellman
+```
+
+## Some projects using shellman
+
+- [shellm](https://github.com/shellm-org) —
+  A collection of scripts and libraries
+  built on a [core inclusion-system](https://github.com/shellm-org/core),
+  all installable with [basher](https://github.com/basherpm/basher).
+  Here are a few examples:
+  - [daemon](https://github.com/shellm-org/daemon) —
+    A library that facilitates the writing of daemonized scripts that consume
+    files in a watched directory.
+  - [debug](https://github.com/shellm-org/debug) —
+    A simple script that sets the verbose/dry-run/debug
+    Bash flags before running another script.
+  - [format](https://github.com/shellm-org/format) —
+    Format your output with style and color.
+  - [home](https://github.com/shellm-org/home) —
+    A home for your shell scripts! 
+  - [loop](https://github.com/shellm-org/loop) —
+    Control the flow of your loops (pause/resume/etc.).