Function gen_readme

skills/python-pypi-package-builder/scripts/scaffold.py:655–700

(name: str, mod: str)

def gen_readme(name: str, mod: str) -> str:
    return f'''\
# {name}

> One-line description — what it does and why it's useful.

[![PyPI version](https://badge.fury.io/py/{name}.svg)](https://pypi.org/project/{name}/)
[![Python Versions](https://img.shields.io/pypi/pyversions/{name})](https://pypi.org/project/{name}/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

## Installation

```bash
pip install {name}
```

## Quick Start

```python
from {mod} import YourClient

client = YourClient(api_key="sk-...")
result = client.process({{"input": "value"}})
print(result)
```

## Configuration

| Parameter | Type | Default | Description |
|---|---|---|---|
| api_key | str | required | Authentication credential |
| timeout | int | 30 | Request timeout in seconds |
| retries | int | 3 | Number of retry attempts |

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## Changelog

See [CHANGELOG.md](./CHANGELOG.md)

## License

MIT — see [LICENSE](./LICENSE)
'''


def gen_setup_py() -> str: