Skip to content

README.md

Latest commit

 

History

History
90 lines (58 loc) · 1.77 KB

README.md

File metadata and controls

90 lines (58 loc) · 1.77 KB

heap-impl

Min-heap and max-heap implementation

PyPI version License: MIT Python 3.8+

Installation

pip install heap-impl

Quick Start

from heap_impl import impl

# Basic usage
result = impl("your input here")
print(result)

Features

  • Simple, clean API with type hints
  • Zero dependencies (pure Python)
  • Python 3.8+ compatible
  • Fully tested
  • Lightweight (< 5KB)

API Reference

impl(input)

Main utility function.

Parameters:

  • input — The input data to process

Returns: Processed result

batch(inputs)

Process multiple inputs at once.

Parameters:

  • inputs — List of inputs

Returns: List of results

Examples

from heap_impl import impl

# Example 1: Basic usage
result = impl("Hello World")

# Example 2: Batch processing
from heap_impl import batch
results = batch(["item1", "item2", "item3"])

Running Tests

pip install pytest
pytest tests/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE file for details.

Learn More

Want to build tools like this? Check out the Python For Beginners course — it teaches you step-by-step how to create useful Python utilities from scratch, with real-world projects and best practices.

Built with skills from Python For Beginners