Skip to content

Add README for Amazon product availability checker#1819

Open
guptaniharika8953 wants to merge 2 commits into
UTSAVS26:mainfrom
guptaniharika8953:add-readme-amazon-checker
Open

Add README for Amazon product availability checker#1819
guptaniharika8953 wants to merge 2 commits into
UTSAVS26:mainfrom
guptaniharika8953:add-readme-amazon-checker

Conversation

@guptaniharika8953
Copy link
Copy Markdown

@guptaniharika8953 guptaniharika8953 commented May 25, 2026

Pull Request for PyVerse 💡

Requesting to submit a pull request to the PyVerse repository.


Issue Title

Add README.md for Amazon Product Availability Checker

  • I have provided the issue title.

Info about the Related Issue

What's the goal of the project?
The Beginner_Projects/Amazon product availability checker/
folder was missing a README.md file. This PR adds a complete
README with project description, tech stack, how to run,
input/output details and use case.

  • I have described the aim of the project.

Name

Niharika Gupta

  • I have provided my name.

GitHub ID

guptaniharika8953

  • I have provided my GitHub ID.

Email ID

0241cse055@niet.co.in

  • I have provided my email ID.

Identify Yourself

GSSoC 2026

  • I have mentioned my participant role.

Closes

Closes: N/A

  • I have provided the issue number.

Describe the Add-ons or Changes You've Made

Added a README.md file for the Amazon Product Availability
Checker project under Beginner_Projects folder.

README includes:

  • Project description
  • Tech stack (Python, BeautifulSoup, Requests)
  • Step by step installation guide
  • How to run the script
  • Input and Output details
  • Use case explanation
  • Author details
  • I have described my changes.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

This is a documentation only change (README.md).
No code was modified. The markdown formatting has been
verified by previewing the file on GitHub.

  • I have described my testing process.

Checklist

  • My code follows the guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly wherever it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added things that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

Summary by CodeRabbit

  • Documentation
    • Added a README for the Amazon Product Availability Checker.
    • Includes setup and dependency installation instructions, how to run the script, and example usage.
    • Documents expected input (Amazon product URL) and output (in-stock vs out-of-stock status).
    • Provides tech stack overview, common use cases, and contributor credits.

Review Change Stack

@github-actions
Copy link
Copy Markdown

👋 Thank you for opening this pull request! We're excited to review your contribution. Please give us a moment, and we'll get back to you shortly!

Feel free to join our community on Discord to discuss more!

@github-actions github-actions Bot requested review from TheChaoticor and UTSAVS26 May 25, 2026 17:51
@github-actions
Copy link
Copy Markdown

PR Validation Failed!

Please fix the following issues in your PR description:

  • The PR does not properly close an issue. Use the format Closes: #123.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 066cac89-e4c7-4d05-b908-e965e3774e7d

📥 Commits

Reviewing files that changed from the base of the PR and between 6cb7a3f and 0860103.

📒 Files selected for processing (1)
  • Beginner_Projects/Amazon product availability checker/README.md
✅ Files skipped from review due to trivial changes (1)
  • Beginner_Projects/Amazon product availability checker/README.md

📝 Walkthrough

Walkthrough

Adds a README for the Amazon Product Availability Checker describing the script’s purpose, tech stack (Python, BeautifulSoup, Requests), install/run steps, expected input (Amazon product URL) and output (in-stock vs out-of-stock), use cases, and contributor attribution.

Changes

Amazon Product Availability Checker Documentation

Layer / File(s) Summary
Project README
Beginner_Projects/Amazon product availability checker/README.md
README documenting the availability checker script (scrapes Amazon pages), Python/BeautifulSoup/Requests stack, installation and run instructions, expected input/output, use cases, and author attribution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Possibly related PRs

  • UTSAVS26/PyVerse#1608: Introduces the same Amazon product availability checker documentation describing the web-scraping workflow.

Suggested labels

Contributor, Status: Review Ongoing 🔄, level1, gssoc25

Suggested reviewers

  • UTSAVS26
  • TheChaoticor

Poem

🐰 A README hops into place,
Telling how to check a product's grace,
Requests fetch pages, Soup does peek,
Prints "in stock" or "out" — quick and sleek,
Hooray for shared code, one small trace!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add README for Amazon product availability checker' directly and clearly describes the main change: adding a README file for the Amazon product availability checker project.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

PR Validation Failed!

Please fix the following issues in your PR description:

  • The PR does not properly close an issue. Use the format Closes: #123.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Beginner_Projects/Amazon` product availability checker/README.md:
- Around line 1-22: The README contains escaped Markdown characters (e.g. '\#
Amazon Product Availability Checker', '\## Description', '\## Tech Stack', '\-
Python', '\- BeautifulSoup / Requests library' and other occurrences at lines
referenced) which prevents proper rendering; remove the leading backslashes from
headings, list markers, and any escaped bracket or markdown characters across
the file (including the other ranges noted) so headings like "## Description"
and list items like "- Python" render correctly and keep existing text content
unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a928a519-94a4-437d-98b7-1cc544fab68e

📥 Commits

Reviewing files that changed from the base of the PR and between 8abd0a0 and 6cb7a3f.

📒 Files selected for processing (1)
  • Beginner_Projects/Amazon product availability checker/README.md

Comment thread Beginner_Projects/Amazon product availability checker/README.md Outdated
@github-actions
Copy link
Copy Markdown

PR Validation Failed!

Please fix the following issues in your PR description:

  • The PR does not properly close an issue. Use the format Closes: #123.

1 similar comment
@github-actions
Copy link
Copy Markdown

PR Validation Failed!

Please fix the following issues in your PR description:

  • The PR does not properly close an issue. Use the format Closes: #123.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant