Metadata-Version: 2.1
Name: pyrecipes
Version: 0.1.0
Summary: A CLI tool to display useful Python recipes.
Author-email: Chris Adams <cfh1990@msn.com>
License: MIT
Project-URL: Homepage, https://pypi.org/project/pyrecipes/
Project-URL: Repository, https://github.com/ChrisA87/pyrecipes
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests >=2.31
Requires-Dist: click
Requires-Dist: colorama

# Pyrecipes

![ci workflow](https://github.com/ChrisA87/pyrecipes/actions/workflows/ci.yml/badge.svg)
![coverage-badge](https://raw.githubusercontent.com/ChrisA87/pyrecipes/aa37d4757dd7ecbc0b1f2ec93eeb55165be12307/coverage.svg)


Recipes from [Python Cookbook, Third Edition](https://www.oreilly.com/library/view/python-cookbook-3rd/9781449357337/), by David Beazley and Brian K. Jones. Copyright © 2013 David Beazley and Brian Jones. Published by O'Reilly Media, Inc. Used with permission.


This project implements a simple CLI tool to list, run and view these recipes.

## Installation

```
pip install pyrecipes
```

---

## Example Usage

### Show recipes help and subcommands
```
recipes
```

### List all chapters
```
recipes chapters
```

### List all recipes
```
recipes ls
```

### List all recipes in a specific chapter
```
recipes ls 1
```

### List all recipes in a specific chapter with a short description
```
recipes ls 1 -d
```

### Show recipe code
```
recipes show 1 3
```

### Run the recipe as a script
```
recipes run 1 3
```

### Search for recipes containing a pattern
RegEx is supported.
```
recipes search 'itertools'
recipes search 'itertools' --color green
recipes search 'event' --ignore-case
recipes search 'functools' -c
recipes search '[a-z]\d[^\s]'
```
