Docs(package/py): add README python package

[Prachi-Gupta2808]

Changes & Reason

Changes

• Added packages/py/README.md — a self-contained README for the Python package
• Updated readme field in root pyproject.toml to point to packages/py/README.md so PyPI renders the Python-specific README

Reason

The img2num package on PyPI currently has no README, making it difficult for users to understand how to install and use the library without browsing the repository.

Related Issues

Fixes: #455

Testing & Verification

Verified markdown renders correctly by previewing locally. All links checked against existing docs and repo paths.

Additional Resources

N/A

[coderabbitai]

Warning

Review limit reached

@Ryan-Millard, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 59 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5faed0c2-f4de-4105-8c74-56241e590a7b

📥 Commits

Reviewing files that changed from the base of the PR and between b63cd54 and b3a90f7.

📒 Files selected for processing (1)

• pyproject.toml

Walkthrough

A new README.md file is added to the Python package documenting overview, installation, quick-start usage, API reference, examples, and build/publish instructions. The pyproject.toml readme metadata field is updated to reference this new file path.

Changes

Python package documentation

Layer / File(s)	Summary
Python package README and metadata update packages/py/README.md, pyproject.toml	Adds a full README for the Python "Img2Num" package covering overview, features, installation, quick-start with RGBA uint8 usage and image_to_svg, API reference, examples, build/publish steps, and license; updates pyproject.toml's readme field to point to packages/py/README.md.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• Ryan-Millard/Img2Num#403: Also modifies pyproject.toml's README/readme metadata as part of PyPI-oriented packaging changes.

Suggested labels: python

Suggested reviewers: Ryan-Millard

Poem

A README hops onto the scene,
Telling PyPI just what we mean,
uint8 and RGBA in tow,
Quick-start guides that help you go,
This bunny thumps in pure delight! 🐇📦

🚥 Pre-merge checks | ✅ 7 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The README covers overview, install, and quick start, but the summary doesn't show the required development/test instructions or full API docs.	Add the missing development/test sections and ensure the public API is fully documented per #455.

✅ Passed checks (7 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes adding a Python package README, matching the main change.
Description check	✅ Passed	The description matches the README addition and pyproject readme update.
Out of Scope Changes check	✅ Passed	The changes stay focused on the Python package README and metadata update, with no clearly unrelated additions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
No Ai Slop Pr Description	✅ Passed	The description names the exact files changed, the PyPI readme redirect, and the user-facing reason; it isn’t generic boilerplate.
No Strangely-Named Root Markdown Files	✅ Passed	The PR only adds packages/py/README.md and updates pyproject.toml; no unconventional markdown files were added at the repository root.
Coderabbit Config Needs Update	✅ Passed	Only a Markdown README was added, and .coderabbit.yaml already enables markdownlint; no new language, config file, or uncovered extension was introduced.

📋 Issue Planner

Built with CodeRabbit's Coding Plans for faster development and fewer bugs.

View plan used: #455

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Ryan-Millard]

Great stuff. Thank you!

There's just a few things I'd like to get done before this gets merged, but it's still great.
Most importantly, I'd like @Krasner to verify one thing in the comment below.

[Ryan-Millard]

Thank you!🦔🦔🦔