relay-app 0.0.1__tar.gz

relay_app-0.0.1/.gitignore

@@ -0,0 +1,141 @@
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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
+
+# ty
+.ty/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Vscode config files
+.vscode/
+
+# Exclude .DS_Store files from being added
+.DS_Store
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# local tests
+local-test/

relay_app-0.0.1/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.0.2] - <Unreleased>
+
+### Added
+
+-
+
+### Changed
+
+-
+
+### Deprecated
+
+-
+
+### Removed
+
+-
+
+### Fixed
+
+-
+
+## Security
+
+-
+
+## [0.0.1] - 2026-08-30
+
+### Added
+
+- Stub release

relay_app-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Visesh Prasad
+
+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.

relay_app-0.0.1/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.5
+Name: relay-app
+Version: 0.0.1
+Summary: This is a template repository for Python projects that use uv for their dependency management.
+Project-URL: Homepage, https://github.com/viseshrp/relay
+Project-URL: Repository, https://github.com/viseshrp/relay
+Project-URL: Documentation, https://github.com/viseshrp/relay/blob/main/README.md
+Project-URL: Changelog, https://github.com/viseshrp/relay/blob/main/CHANGELOG.md
+Project-URL: Bug-Tracker, https://github.com/viseshrp/relay/issues
+Project-URL: CI, https://github.com/viseshrp/relay/actions
+Author-email: Visesh Prasad <viseshrprasad@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: python
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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 :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4.0,>=3.10
+Requires-Dist: click>=8.5.0
+Description-Content-Type: text/markdown
+
+# relay
+
+[![PyPI version](https://img.shields.io/pypi/v/relay.svg)](https://pypi.org/project/relay/)
+[![Python versions](https://img.shields.io/pypi/pyversions/relay.svg?logo=python&logoColor=white)](https://pypi.org/project/relay/)
+[![CI](https://github.com/viseshrp/relay/actions/workflows/main.yml/badge.svg)](https://github.com/viseshrp/relay/actions/workflows/main.yml)
+[![Coverage](https://codecov.io/gh/viseshrp/relay/branch/main/graph/badge.svg)](https://codecov.io/gh/viseshrp/relay)
+[![License: MIT](https://img.shields.io/github/license/viseshrp/relay)](https://github.com/viseshrp/relay/blob/main/LICENSE)
+[![Format: Ruff](https://img.shields.io/badge/format-ruff-000000.svg)](https://docs.astral.sh/ruff/formatter/)
+[![Lint: Ruff](https://img.shields.io/badge/lint-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+[![Typing: ty](https://img.shields.io/badge/typing-checked-blue.svg)](https://docs.astral.sh/ty/)
+
+> This is a template repository for Python projects that use uv for their dependency management.
+
+![Demo](https://raw.githubusercontent.com/viseshrp/relay/main/demo.gif)
+
+## 🚀 Why this project exists
+
+Explain the problem this tool solves or the goal it's intended to fulfill.
+
+## 🧠 How this project works
+
+Explain how the tool works.
+
+## 📐 Requirements
+
+* Python >= 3.10
+
+## 🏁 Initial project setup
+
+Cruft creates `.cruft.json` after the template finishes generating the project, so the template initializes Git without
+making a commit. Create the lockfile, validate the generated project, and then make the first commit:
+
+```bash
+uv sync
+uv run pre-commit install
+git add .
+make check
+make test-local
+git add .
+git commit -m "Initial commit"
+```
+
+The first commit will include both Cruft's template-tracking file (`.cruft.json`) and uv's reproducibility lockfile
+(`uv.lock`).
+
+## 📦 Installation
+
+```bash
+pip install relay
+```
+
+## 🧪 Usage
+
+* To view the help message, run the following command:
+
+<!-- [[[cog
+import cog
+from click.testing import CliRunner
+
+from relay.cli import main
+
+result = CliRunner().invoke(
+    main,
+    ["--help"],
+    prog_name="relay",
+)
+if result.exit_code != 0:
+    raise RuntimeError(result.output) from result.exception
+
+cog.outl("```console")
+cog.outl("$ " + "relay" + " --help")
+cog.out(result.output)
+cog.outl("```")
+]]] -->
+```console
+$ relay --help
+Usage: relay [OPTIONS] <what_you_worked_on>
+
+  Relay CLI.
+
+  Example usages:
+
+Options:
+  -v, --version  Show the version and exit.
+  -h, --help     Show this message and exit.
+```
+<!-- [[[end]]] -->
+
+## 🛠️ Features
+
+* Does stuff
+
+## 🧾 Changelog
+
+See [CHANGELOG.md](https://github.com/viseshrp/relay/blob/main/CHANGELOG.md)
+
+## 🙏 Credits
+
+* [Click](https://click.palletsprojects.com), for enabling delightful CLI development.
+* Inspired by [Simon Willison](https://github.com/simonw)'s work.
+
+## 📄 License
+
+MIT © [Visesh Prasad](https://github.com/viseshrp)

relay_app-0.0.1/README.md

@@ -0,0 +1,104 @@
+# relay
+
+[![PyPI version](https://img.shields.io/pypi/v/relay.svg)](https://pypi.org/project/relay/)
+[![Python versions](https://img.shields.io/pypi/pyversions/relay.svg?logo=python&logoColor=white)](https://pypi.org/project/relay/)
+[![CI](https://github.com/viseshrp/relay/actions/workflows/main.yml/badge.svg)](https://github.com/viseshrp/relay/actions/workflows/main.yml)
+[![Coverage](https://codecov.io/gh/viseshrp/relay/branch/main/graph/badge.svg)](https://codecov.io/gh/viseshrp/relay)
+[![License: MIT](https://img.shields.io/github/license/viseshrp/relay)](https://github.com/viseshrp/relay/blob/main/LICENSE)
+[![Format: Ruff](https://img.shields.io/badge/format-ruff-000000.svg)](https://docs.astral.sh/ruff/formatter/)
+[![Lint: Ruff](https://img.shields.io/badge/lint-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+[![Typing: ty](https://img.shields.io/badge/typing-checked-blue.svg)](https://docs.astral.sh/ty/)
+
+> This is a template repository for Python projects that use uv for their dependency management.
+
+![Demo](https://raw.githubusercontent.com/viseshrp/relay/main/demo.gif)
+
+## 🚀 Why this project exists
+
+Explain the problem this tool solves or the goal it's intended to fulfill.
+
+## 🧠 How this project works
+
+Explain how the tool works.
+
+## 📐 Requirements
+
+* Python >= 3.10
+
+## 🏁 Initial project setup
+
+Cruft creates `.cruft.json` after the template finishes generating the project, so the template initializes Git without
+making a commit. Create the lockfile, validate the generated project, and then make the first commit:
+
+```bash
+uv sync
+uv run pre-commit install
+git add .
+make check
+make test-local
+git add .
+git commit -m "Initial commit"
+```
+
+The first commit will include both Cruft's template-tracking file (`.cruft.json`) and uv's reproducibility lockfile
+(`uv.lock`).
+
+## 📦 Installation
+
+```bash
+pip install relay
+```
+
+## 🧪 Usage
+
+* To view the help message, run the following command:
+
+<!-- [[[cog
+import cog
+from click.testing import CliRunner
+
+from relay.cli import main
+
+result = CliRunner().invoke(
+    main,
+    ["--help"],
+    prog_name="relay",
+)
+if result.exit_code != 0:
+    raise RuntimeError(result.output) from result.exception
+
+cog.outl("```console")
+cog.outl("$ " + "relay" + " --help")
+cog.out(result.output)
+cog.outl("```")
+]]] -->
+```console
+$ relay --help
+Usage: relay [OPTIONS] <what_you_worked_on>
+
+  Relay CLI.
+
+  Example usages:
+
+Options:
+  -v, --version  Show the version and exit.
+  -h, --help     Show this message and exit.
+```
+<!-- [[[end]]] -->
+
+## 🛠️ Features
+
+* Does stuff
+
+## 🧾 Changelog
+
+See [CHANGELOG.md](https://github.com/viseshrp/relay/blob/main/CHANGELOG.md)
+
+## 🙏 Credits
+
+* [Click](https://click.palletsprojects.com), for enabling delightful CLI development.
+* Inspired by [Simon Willison](https://github.com/simonw)'s work.
+
+## 📄 License
+
+MIT © [Visesh Prasad](https://github.com/viseshrp)

relay_app-0.0.1/pyproject.toml

@@ -0,0 +1,261 @@
+[project]
+name = "relay-app"
+dynamic = ["version"]
+description = "This is a template repository for Python projects that use uv for their dependency management."
+authors = [{ name = "Visesh Prasad", email = "viseshrprasad@gmail.com" }]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["python"]
+requires-python = ">=3.10,<4.0"
+dependencies = ["click>=8.5.0", ]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Environment :: Console",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+[project.urls]
+Homepage = "https://github.com/viseshrp/relay"
+Repository = "https://github.com/viseshrp/relay"
+Documentation = "https://github.com/viseshrp/relay/blob/main/README.md"
+Changelog = "https://github.com/viseshrp/relay/blob/main/CHANGELOG.md"
+Bug-Tracker = "https://github.com/viseshrp/relay/issues"
+CI = "https://github.com/viseshrp/relay/actions"
+
+[project.scripts]
+"relay" = "relay.__main__:main"
+
+[dependency-groups]
+dev = [
+    "ipdb",
+    "uv",
+    "tox",
+    "tox-uv",
+    "tox-gh-actions",
+    "pytest",
+    "pytest-cov",
+    "pre-commit",
+    "ruff",
+    "pip-audit",
+    "bandit[toml]",
+    "codespell",
+    "ty",
+    "vulture",
+    "deptry",
+    "liccheck",
+    # liccheck imports pkg_resources, which newer setuptools no longer provides.
+    "setuptools<81",
+    "cogapp",
+    "twine",
+    "hatch",
+]
+
+[build-system]
+requires = ["hatchling", "hatch-timestamp-version"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "relay/_version.py"
+source = "vcs-dev-timestamp"
+validate-bump = true
+
+[tool.hatch.version.raw-options]
+local_scheme = "no-local-version"
+timestamp_format = "long"
+fallback_version = "0.0.0"
+
+[tool.hatch.build]
+include = [
+  "relay/**",
+  "README.md",
+  "LICENSE",
+  "CHANGELOG.md"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["relay"]
+
+[tool.hatch.build.targets.editable]
+packages = ["relay"]
+
+[tool.hatch.envs.default]
+path = ".venv"
+
+[tool.uv]
+default-groups = "all"
+
+[tool.ty.src]
+include = [
+    "relay"
+]
+
+[tool.ty.environment]
+python-version = "3.10"
+
+[tool.ty.analysis]
+allowed-unresolved-imports = ["**"]
+
+[tool.ty.rules]
+unused-type-ignore-comment = "error"
+
+[tool.pytest.ini_options]
+tmp_path_retention_policy = "failed"
+testpaths = ["tests"]
+addopts = "--capture=tee-sys --tb=native -ra -vv"
+markers = [
+    "integration:Run integration tests",
+    "smoke:Run the smoke tests",
+    "unit:Run the unit tests",
+]
+norecursedirs = [
+    ".git",
+    ".idea",
+]
+
+# Configuration for coverage.py
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+# Regexes for lines to exclude from consideration
+exclude_lines = [
+    # Have to re-enable the standard pragma
+    "pragma: no cover",
+    # Don't complain about missing debug-only code:
+    "def __repr__",
+    "if self\\.debug",
+    # Don't complain if tests don't hit defensive assertion code:
+    "raise AssertionError",
+    "raise NotImplementedError",
+    # Don't complain if non-runnable code isn't run:
+    "if 0:",
+    "if __name__ == .__main__.:",
+    # Don't complain about abstract methods, they aren't run:
+    "@(abc\\.)?abstractmethod",
+]
+
+[tool.coverage.run]
+branch = true
+omit = ["relay/__main__.py"]
+source = [
+    "relay"
+]
+
+[tool.coverage.html]
+show_contexts = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+fix = true
+unsafe-fixes = true
+exclude = [".venv", "__init__.py"]
+
+[tool.ruff.lint]
+fixable = ["ALL"]
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort (keep this if you want Ruff to sort imports)
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pep8-naming rules
+    "N",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff-native rules
+    "RUF",
+    # try/except linting
+    "TRY",
+    # Disallow print statements
+    "T201",
+]
+ignore = [
+    "C901", # Function is too complex
+    "PGH003" # blanket-type-ignore
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101"]
+"scripts/*.py" = ["T201"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["relay", "tests"]
+force-sort-within-sections = true
+
+[tool.codespell]
+ignore-words = "codespell.txt"
+skip = '*.pyc,*.xml,*.gif,*.png,*.jpg,*.js,*.html,*.json,*.gz,Makefile'
+quiet-level = 3
+
+[tool.bandit]
+targets = ["relay"]
+exclude_dirs = ["venv", ".venv", "tests"]
+
+[tool.vulture]
+paths = ["relay", "tests"]
+min_confidence = 80
+sort_by_size = true
+exclude = ["venv/", ".venv/"]
+
+[tool.deptry]
+exclude = ["venv/.*", ".venv/.*", "tests/.*"]
+
+[tool.liccheck]
+authorized_licenses = [
+    "apache",
+    "apache 2.0",
+    "apache software license",
+    "bsd",
+    "bsd license",
+    "bsd-3-clause",
+    "isc",
+    "isc license",
+    "mit",
+    "mit license",
+    "python software foundation license",
+]
+unauthorized_licenses = [
+    "agpl",
+    "gpl",
+    "gpl v2",
+    "gpl v3",
+    "gnu affero general public license",
+    "gnu general public license",
+]
+dependencies = true
+
+[tool.pre-commit.default_language_versions]
+python = "3.14"

relay_app-0.0.1/relay/__init__.py

@@ -0,0 +1,6 @@
+"Top-level package for relay."
+
+from ._version import __version__
+from .cli import main
+
+__all__ = ["__version__", "main"]

relay_app-0.0.1/relay/__main__.py

@@ -0,0 +1,6 @@
+"The main entry point for the relay package."
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

relay_app-0.0.1/relay/_version.py

@@ -0,0 +1,12 @@
+"The version module for the relay package."
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("relay-app")
+except PackageNotFoundError:  # pragma: no cover
+    try:
+        __version__ = version("relay")
+    except PackageNotFoundError:
+        # Fallback for local dev or editable installs
+        __version__ = "0.0.0"

relay_app-0.0.1/relay/cli.py

@@ -0,0 +1,24 @@
+"The console script for relay."
+
+import click
+
+from . import __version__ as _version
+from .relay import do_stuff
+
+
+@click.argument(
+    "stuff",
+    metavar="<what_you_worked_on>",
+    nargs=-1,
+    required=False,
+    type=click.STRING,
+)
+@click.command(context_settings={"help_option_names": ["-h", "--help"]})
+@click.version_option(_version, "-v", "--version")
+def main(stuff: tuple[str, ...]) -> None:
+    """Relay CLI.
+
+    \b
+    Example usages:
+    """
+    do_stuff(stuff)

relay_app-0.0.1/relay/constants.py

@@ -0,0 +1 @@
+"""All constants used in the code base are defined here."""

relay_app-0.0.1/relay/exceptions.py

@@ -0,0 +1,21 @@
+"""All exceptions used in the code base are defined here."""
+
+from __future__ import annotations
+
+
+class CustomError(Exception):
+    """
+    Base exception. All other exceptions
+    inherit from here.
+    """
+
+    detail = "An error occurred."
+
+    def __init__(self, extra_detail: str | None = None) -> None:
+        super().__init__()
+        self.extra_detail = extra_detail
+
+    def __str__(self) -> str:
+        if self.extra_detail:
+            return f"{self.detail} :: {self.extra_detail}"
+        return self.detail

relay_app-0.0.1/relay/relay.py

@@ -0,0 +1,6 @@
+"""All the core functionality of the code base is defined here."""
+
+
+def do_stuff(something: tuple[str, ...]) -> tuple[str, ...]:
+    """Do stuff."""
+    return something

relay_app-0.0.1/relay/utils.py

@@ -0,0 +1 @@
+"""All common utility functions and classes used in the code base are defined here."""