typer-repyt 0.2.0__tar.gz

typer_repyt-0.2.0/.github/workflows/deploy.yml

@@ -0,0 +1,28 @@
+name: Deploy on tag
+run-name: deploy-on-tag
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python
+      run: uv python install 3.13
+
+    - name: Build package
+      run: uv build
+
+    - name: Publish package
+      run: uv publish --token=${{ secrets.PYPI_API_KEY }}

typer_repyt-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs on main
+run-name: build-docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'src/typer_repyt/**'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python
+      run: uv python install 3.13
+
+    - name: Build Documentation
+      run: |
+        make docs/build
+
+    - name: Deploy documentation
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/site

typer_repyt-0.2.0/.github/workflows/main.yml

@@ -0,0 +1,44 @@
+name: QA on push
+run-name: qa-checks
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - '3.12'
+          - '3.13'
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Install python
+      run:  uv python install ${{ matrix.python-version }}
+
+    - name: Check Quality
+      run: make qa/full
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        files: ./.coverage.xml
+        token: ${{ secrets.CODECOV_TOKEN }}
+      if: success()
+
+    - name: Upload test results to Codecov
+      uses: codecov/test-results-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./.junit.xml
+      if: success()

typer_repyt-0.2.0/.gitignore

@@ -0,0 +1,148 @@
+.junit.xml
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.DS_Store
+# C extensions
+*.so
+*.job
+osu_*
+mpi-*
+param_dict.json
+*.tar*
+*java*
+application.sh
+lgcy*
+~*
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+starccm_app/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.idea/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/docs/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# git
+.git/
+
+# vs code
+/*.code-workspace
+/.vscode
+
+# snapcraft
+/*.snap

typer_repyt-0.2.0/.python-version

@@ -0,0 +1 @@
+3.13

typer_repyt-0.2.0/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+
+## v0.2.0 - 2025-04-17
+- Renamed the project to `typer-repyt`
+- Completed `build_command` function
+- Added documentation for the `build_command` feature
+- Added examples of the `build_command` feature
+- Added a logo
+
+
+## v0.1.0 - 2025-04-15
+- Generated project from template

typer_repyt-0.2.0/CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct([2.1](https://www.contributor-covenant.org/version/2/1/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 email 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
+[tucker.beck@gmail.com](mailto:tucker.beck@gmail.com).
+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

typer_repyt-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,128 @@
+# Contributing Guidelines
+
+## Security Concerns
+
+Before any further discussion, a point about security needs to be addressed:
+
+> [!WARNING]
+> If you find a serious security vulnerability that could affect current users, please report it to maintainers via
+> email or some form of private communication. For other issue reports, see below.
+
+
+## Thanks!
+
+First, thank you for your interest in contributing to typer-repyt! Even though this is mostly a personal project,
+it takes a bit of work to keep it maintained. All contributions help and improve it.
+
+
+## Contact Us
+
+The maintainers of typer-repyt can be reached most easily via email:
+
+* **Tucker Beck**: [tucker.beck@gmail.com](mailto:tucker.beck@gmail.com)
+
+
+## Conduct
+
+Everyone's conduct should be respectful and friendly. For most folks, these things don't need to be spelled out.
+However, to establish a baseline of acceptable conduct, the typer-repyt project expects contributors to adhere to
+the [Code of Conduct](./CONDUCT.md) for this project. Any issues working with other contributors should be reported to
+the maintainers
+
+
+## Contribution Recommendations
+
+### Github Issues
+
+The first and primary source of contributions is opening issues on github. Please feel free to open issues when you find
+problems or wish to request a feature. All issues will be treated seriously and taken under consideration. However, the
+maintainers may disregard/close issues at their discretion.
+
+Issues are most helpful when they contain specifics about the problem they address. Specific error messages, references
+to specific lines of code, environment contexts, and such are extremely helpful.
+
+
+### Code Contributions
+
+Code contributions should be submitted via pull-requests on github. Project maintainers will review pull-requests and
+may test new features out. All merge requests should come with commit messages that describe the changes as well as a
+reference to the issue that the code addresses. Commit messages should also adhere to
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+
+Commit messages should look like this:
+
+```
+fix: Fixed gizmo component that was parfolecting
+
+Addresses Issue #56
+
+The parfolection happening in the gizmo component was causing a vulterability in the anti-parfolection checks during the
+enmurculation process.
+
+This was addressed by caching the restults of parfolection prior to enmurculation.
+
+Also:
+* Added and updated unit tests
+* Added documentation
+* Cleaned up some code
+```
+
+> [!Note]
+> The maintainers of typer-repyt _hate_ the use of `!` to indicate breaking changes in the subject line. If you
+> introduce a breaking change, please note it in a _footer_ instead.
+
+Code contributions should follow best-practices where possible. Use the
+[Zen of Python](https://www.python.org/dev/peps/pep-0020/) as a guideline. All code must stick to pep8 style guidelines.
+
+Adding additional dependencies should be limited except where needed functionality can be easily added through pip
+packages. Please include dependencies that are only applicable to development and testing in the dev dependency list.
+Packages should only be added to the dependency lists if:
+
+* They are actively maintained
+* They are widely used
+* They are hosted on pypi.org
+* They have source code hosted on a public repository (github, gitlab, bitbucket, etc)
+* They include tests in their repositories
+* They include a software license
+
+
+### Documentation
+
+Help with documentation is *always* welcome.
+
+The typer-repyt project uses [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) for document
+generation.
+
+Documentation lives in the `docs` subdirectory.
+
+Documentation should be clear, include examples where possible, and reference source material as much as possible.
+
+Documentation through code comments should be kept to a minimum. Code should
+be as self-documenting as possible. If a section of code needs some explanation,
+the bulk of it should be be presented as docstrings that use
+[Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
+`docstrings <https://www.python.org/dev/peps/pep-0257/>`_ for methods, modules,
+and classes.
+
+> [!Note]
+> The maintainers of typer-repyt don't like starting the docstring on the same line as the triple-quotes.
+> Instead, the > docstring should stat on a new line:
+>
+> ```python
+> def gizmo():
+>     """"
+>     Parfolect the enmurculation process.
+>     """
+>     ...
+> ```
+
+
+## Non-preferred Contributions
+
+There are some types of contribution that aren't as helpful and are not as welcome:
+
+* Complaints without suggestion
+* Criticism about the overall approach of the extension
+* Copied code without attribution
+* Promotion of personal packages/projects without due need
+* Sarcasm/ridicule of contributions or design choices

typer_repyt-0.2.0/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) `2025` `Tucker Beck`
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

typer_repyt-0.2.0/Makefile

@@ -0,0 +1,71 @@
+.ONESHELL:
+.DEFAULT_GOAL:=help
+SHELL:=/bin/bash
+PACKAGE_TARGET:=src/typer_repyt
+
+
+# ==== Helpers =========================================================================================================
+.PHONY: confirm
+confirm:  ## Don't use this directly
+	@echo -n "Are you sure? [y/N] " && read ans && [ $${ans:-N} = y ]
+
+
+.PHONY: help
+help:  ## Show help message
+	@awk 'BEGIN {FS = ": .*##"; printf "\nUsage:\n  make \033[36m\033[0m\n"} /^[$$()% 0-9a-zA-Z_\/-]+(\\:[$$()% 0-9a-zA-Z_\/-]+)*:.*?##/ { gsub(/\\:/,":", $$1); printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+.PHONY: clean
+clean:  ## Clean up build artifacts and other junk
+	@rm -rf .venv
+	@uv run pyclean . --debris
+	@rm -rf dist
+	@rm -rf .ruff_cache
+	@rm -rf .pytest_cache
+	@rm -rf .mypy_cache
+	@rm -f .coverage*
+	@rm -f .junit.xml
+
+
+# ==== Quality Control =================================================================================================
+.PHONY: qa/test
+qa/test:  ## Run the tests
+	uv run pytest
+
+.PHONY: qa/types
+qa/types:  ## Run static type checks
+	uv run mypy ${PACKAGE_TARGET} tests --pretty
+	uv run basedpyright ${PACKAGE_TARGET} tests
+
+.PHONY: qa/lint
+qa/lint:  ## Run linters
+	uv run ruff check ${PACKAGE_TARGET} tests
+	uv run typos ${PACKAGE_TARGET} tests
+
+.PHONY: qa/full
+qa/full: qa/test qa/lint qa/types  ## Run the full set of quality checks
+	@echo "All quality checks pass!"
+
+.PHONY: qa/format
+qa/format:  ## RUn code formatter
+	uv run ruff format ${PACKAGE_TARGET} tests
+
+
+# ==== Documentation ===================================================================================================
+.PHONY: docs/build
+docs/build:  ## Build the documentation
+	uv run mkdocs build --config-file=docs/mkdocs.yaml
+
+.PHONY: docs/serve
+docs/serve:  ## Build the docs and start a local dev server
+	uv run mkdocs serve --config-file=docs/mkdocs.yaml --dev-addr=localhost:10000
+
+
+# ==== App Commands ====================================================================================================
+.PHONY: app/run
+app/run:  ## Run the app in debug mode
+	uv run src/typer_repyt/command_builder.py
+
+.PHONY: app/debug
+app/debug:  ## Run the app in debug mode
+	uv run debugpy --listen localhost:5678 --wait-for-client src/typer_repyt/command_builder.py
+

typer_repyt-0.2.0/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: typer-repyt
+Version: 0.2.0
+Summary: Tools to extended functionality for typer based CLIs
+Project-URL: homepage, https://github.com/dusktreader/typer-repyt
+Project-URL: source, https://github.com/dusktreader/typer-repyt
+Project-URL: changelog, https://github.com/dusktreader/typer-repyt/blob/main/CHANGELOG.md
+Author-email: Tucker Beck <tucker.beck@gmail.com>
+License-File: LICENSE.md
+Requires-Python: >=3.12,~=3.13
+Requires-Dist: py-buzz>=7.0.0
+Requires-Dist: snick~=2.1
+Requires-Dist: typer>=0.15.2
+Description-Content-Type: text/markdown
+
+[![Latest Version](https://img.shields.io/pypi/v/typer-repyt?label=pypi-version&logo=python&style=plastic)](https://pypi.org/project/typer-repyt/)
+[![Python Versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fdusktreader%2Ftyper-repyt%2Fmain%2Fpyproject.toml&style=plastic&logo=python&label=python-versions)](https://www.python.org/)
+[![Build Status](https://github.com/dusktreader/typer-repyt/actions/workflows/main.yml/badge.svg)](https://github.com/dusktreader/typer-repyt/actions/workflows/main.yml)
+[![Documentation Status](https://github.com/dusktreader/typer-repyt/actions/workflows/docs.yml/badge.svg)](https://dusktreader.github.io/typer-repyt/)
+
+
+![typer-repyt-logo](https://github.com/dusktreader/typer-repyt/blob/main/docs/source/images/logo-dark.png)
+
+_Tools to extended functionality for typer based CLIs_
+
+
+## Super-quick Start
+
+Requires: Python 3.12 to 3.13
+
+Install through pip:
+
+```bash
+pip install typer-repyt
+```
+
+
+## Documentation
+
+The complete documentation can be found at the
+[typer-repyt home page](https://dusktreader.github.io/typer-repyt)