Metadata-Version: 2.5
Name: pymethodbook
Version: 0.1.0
Summary: A terminal-first reference tool for Python's built-in methods — curated descriptions, runnable examples, and a searchable CLI.
Project-URL: Homepage, https://github.com/logeshchandrasekar/pymethodbook
Project-URL: Repository, https://github.com/logeshchandrasekar/pymethodbook
Project-URL: Issues, https://github.com/logeshchandrasekar/pymethodbook/issues
Author-email: Logesh Chandrasekar <logeshwarchandrasekar@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: builtins,cheatsheet,cli,documentation,python,reference
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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: Topic :: Software Development :: Documentation
Requires-Python: >=3.8
Requires-Dist: rich>=13.0
Requires-Dist: typer>=0.9
Description-Content-Type: text/markdown

# pymethodbook

A terminal-first reference tool for Python's built-in methods — curated descriptions, runnable examples, and a searchable CLI. No more digging through docs for what `list.sort()` actually does.

## Why

`dir()` and `help()` give you names and terse docstrings. pymethodbook gives you a one-line description, a runnable example, and a category tag for every method — right in your terminal, in code or from the command line.

## Install

```bash
pip install pymethodbook
```

## Usage

### As a CLI

```bash
pymethodbook explain list append
pymethodbook list dict
pymethodbook search copy
```

### As a library

```python
from pymethodbook import explain, enlist, search

explain("list", "append")
enlist("dict")
search("copy")
```

## Currently covers

- `list` — 11 methods
- `dict` — 11 methods

More types (`str`, `set`, `tuple`) are on the roadmap — see [ROADMAP.md](ROADMAP.md).

## Contributing

Adding a method doesn't require touching any Python code — see [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT — see [LICENSE](LICENSE).