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)
