# Fishertools

**Tools that make Python easier and safer for beginners**

Fishertools is a Python library designed specifically for beginner developers. It provides clear error explanations, safe utilities, and learning tools to help you master Python.

## Quick Start

```bash
pip install fishertools
```

## Quick Reference

| Task | Function |
|------|----------|
| Explain an error | `explain_error(e)` |
| Get element safely | `safe_get(list, index, default)` |
| Divide safely | `safe_divide(a, b, default)` |
| Read file safely | `safe_read_file(path)` |
| Learn Python concepts | `explain(topic)` |

## Documentation

Complete documentation is available in the `docs/` folder:

- **[Getting Started](docs/getting-started.md)** - Quick start guide with installation and first example
- **[Features](docs/features.md)** - Overview of all features and capabilities
- **[Installation](docs/installation.md)** - Detailed installation instructions for different operating systems
- **[API Reference](docs/api-reference.md)** - Complete API documentation with all functions and classes
- **[Examples](docs/examples.md)** - Practical examples from basic to advanced usage
- **[Limitations](docs/limitations.md)** - Known limitations and performance considerations
- **[Contributing](docs/contributing.md)** - How to contribute to the project

## For Whom This Library?

- You're just starting to learn Python
- Error messages seem scary and confusing
- You want errors explained in plain language with examples

## Main Features

### Error Explanation
Get clear explanations of Python errors with suggestions for fixing them.

### Safe Utilities
Functions like `safe_get()`, `safe_divide()`, `safe_read_file()` that prevent typical beginner errors.

### Learning Tools
Structured explanations of Python concepts with examples and best practices.

### Ready-made Patterns
Templates for common tasks like menus, file storage, logging, and CLI applications.

## License

MIT License - see [LICENSE](LICENSE) file

## Contributing

We welcome contributions! See [Contributing](docs/contributing.md) for details.

---

**Fishertools** - Making Python easier and safer for beginners! 🐍✨
