Skip to content

docs: add docs/scripts.md index of the 13 scripts and link it from README #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
utk2103 merged 1 commit into from
Oct 12, 2026
Merged

docs: add docs/scripts.md index of the 13 scripts and link it from README #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Work top to bottom. Each notebook is self-contained, so you can also jump straig
| [Seaborn 1](notebooks/Seaborn%201.ipynb) → [2](notebooks/Seaborn%202.ipynb) → [3](notebooks/Seaborn%203.ipynb) → [4](notebooks/Seaborn%204.ipynb) | statistical plots, distributions, categorical plots, heatmaps |

### 5. Runnable scripts
Algorithms and small programs in [`scripts/`](scripts/) — searching, sorting, recursion, CLIs, threading, `enum`. A full index with one-line descriptions is [issue #15](https://github.com/utk2103/Python-for-beginners/issues/15), up for grabs.
Algorithms and small programs in [`scripts/`](scripts/) — searching, sorting, recursion, CLIs, threading, `enum`. The full index with one-line descriptions and how to run each one is in [`docs/scripts.md`](docs/scripts.md).

---

Expand Down
21 changes: 21 additions & 0 deletions docs/scripts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# `scripts/` index

Standalone runnable `.py` files — one concern each, no shared imports.
Most need only the standard library; a few call out external packages
in their header. Run them from the repo root.

| Script | What it does | Run it |
|---|---|---|
| [`01.TwoSum.py`](../scripts/01.TwoSum.py) | LeetCode-style **Two Sum** using a sort + two-pointer pass over `(value, index)` pairs; returns the original indices of the two numbers that add up to the target. Class only — no CLI; import `Solution` to reuse. | `python -c "import importlib.util as u; m=u.spec_from_file_location('s','scripts/01.TwoSum.py'); mod=u.module_from_spec(m); m.loader.exec_module(mod); print(mod.Solution().twoSum([2,7,11,15], 9))"` or paste into a scratch file |
| [`argparse_1.py`](../scripts/argparse_1.py) | CLI arithmetic demo built on `argparse`: takes two ints and an `add`/`subtract`/`multiply` choice, prints the result. Shows `--help` and type-checked choices. | `python scripts/argparse_1.py 7 3 multiply` |
| [`BinarySearch.py`](../scripts/BinarySearch.py) | Iterative binary search on a sorted list; searches for `4` in `[3,4,5,6,7,8,9]` and prints the index. | `python scripts/BinarySearch.py` |
| [`check.py`](../scripts/check.py) | Scratch-pad demo used to learn terminal I/O in VS Code: prints "Hello world", reads one number via `input()`, and prints a movie list. | `python scripts/check.py` |
| [`csv_json_converter.py`](../scripts/csv_json_converter.py) | Converts between a CSV file and a JSON file of flat objects; auto-detects direction from the `.csv` / `.json` extension of the two path arguments. Validates the JSON is a list of dicts and wraps a lone dict into a list so `csv.DictWriter` accepts it. | `python scripts/csv_json_converter.py in.csv out.json` |
| [`enum_use_case.py`](../scripts/enum_use_case.py) | One-line `enum.Enum` demo: defines `OrderStatus` with `PENDING` / `SHIPPED` / `DELIVERED` and prints the current status value. | `python scripts/enum_use_case.py` |
| [`guess_the_number.py`](../scripts/guess_the_number.py) | Two-mode number-guessing game — (1) you guess the computer's secret in `1..100`, (2) the computer binary-searches your number in `1..1000`. Includes a `max_guesses` helper derived from `ceil(log2(n+1))` and input-validation loops. | `python scripts/guess_the_number.py` (interactive) |
| [`LinearSearch.py`](../scripts/LinearSearch.py) | Simple linear scan for a target in an unsorted list; searches for `1` in `[2,4,0,1,9]` and prints the index. | `python scripts/LinearSearch.py` |
| [`MergeSort.py`](../scripts/MergeSort.py) | In-place recursive merge sort with a comment walk-through; sorts `[6,5,12,10,9,1]` and prints the result. | `python scripts/MergeSort.py` |
| [`multithreading.py`](../scripts/multithreading.py) | Runs "square each" and "cube each" worker threads in parallel over the same list. Uses `time.sleep(1)` per item to simulate work and prints total wall-clock time to show the speedup. | `python scripts/multithreading.py` |
| [`pdf2doc.py`](../scripts/pdf2doc.py) | PDF → DOCX converter using the `pdf2docx` library. Converts a hard-coded `ListsOfInbuiltMethods.pdf` in the current working directory to `ListsOfInbuiltMethods.docx`. | `pip install pdf2docx` then `python scripts/pdf2doc.py` (from a CWD containing the PDF) |
| [`qr_code_generator.py`](../scripts/qr_code_generator.py) | CLI that turns a text string or URL into a QR code PNG; refuses to overwrite an existing output file. | `pip install "qrcode[pil]"` then `python scripts/qr_code_generator.py "https://example.com" -o qr.png` |
| [`toh.py`](../scripts/toh.py) | Towers of Hanoi: prompts for a disk count and prints each `move X to Y` step via the classic three-peg recursion. | `python scripts/toh.py` (interactive) |
Loading