Metadata-Version: 2.4
Name: algocode
Version: 0.1.0
Summary: Call an algorithm by name and get its source code, explanation, complexity, and a step-by-step trace on your own data.
License: MIT
Project-URL: Homepage, https://github.com/yourname/algocode
Keywords: algorithms,competitive-programming,sorting,education,code-generation
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Education
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# algocode

Call an algorithm by name and get its **source code**, an **explanation**, its
**complexity**, and an optional **step-by-step trace** on your own data.

Built for competitive programming: grab a clean, ready-to-paste implementation
in seconds, or watch how an algorithm behaves on a specific input.

## Install

```bash
pip install algocode        # once published
# or, from source:
pip install .
```

## Usage

```python
import algocode as ac

algo = ac.get("quicksort")

print(algo.code())       # ready-to-paste source string
print(algo.explain())    # summary + complexity table
algo.trace([3, 1, 2])    # step-by-step run on your data

ac.available()           # ['bubblesort', 'insertionsort', 'mergesort', ...]
```

Aliases work too: `ac.get("merge")`, `ac.get("quick_sort")`.

## What's included

Sorting: quicksort, mergesort, bubblesort, insertionsort, selectionsort.

## Roadmap

- More algorithms: binary search, BFS/DFS, Dijkstra, DSU, sieve
- C++ and Java code output (competitive-programming standard)
- Optional visual trace (HTML)

## License

MIT
