https://github.com/lamdav/inventory-scan

CLI Inventory Scanner
https://github.com/lamdav/inventory-scan

amazon bestbuy cli click python scrapy slack

Last synced: about 2 months ago
JSON representation

CLI Inventory Scanner

• Host: GitHub
• URL: https://github.com/lamdav/inventory-scan
• Owner: lamdav
• Created: 2020-07-18T10:33:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T00:41:37.000Z (almost 2 years ago)
• Last Synced: 2024-04-12T16:09:43.044Z (9 months ago)
• Topics: amazon, bestbuy, cli, click, python, scrapy, slack
• Language: Python
• Homepage:
• Size: 170 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Inventory Scan

## CLI to periodically check if a product is available for purchase

## Install

1. Install `poetry`

2. Run `poetry install`

3. Run `poetry shell`

4. Run `cp settings.yaml settings.local.yaml`

5. Modify the `setting.local.yaml`:

   - Update `scans` with store page url of what you want to track

   - Update `email` configuration if you want to be notified by email

   - Update `slack` configuration if you want to be notified in a slack workspace

## Usage

```shell

inv scan [--notifier/-n] (console|email|slack)

```

## Supported Stores

- Amazon

- BestBuy

## Supported Notifiers

- Console: Logs to the console item availability. Useful for debugging.

- Email: Uses email credentials to send bulk message to recipients.

  Highly recommend using an app password over your real account password.

- Slack: Send a slack message to a specific channel in a workspace.

## Extending Stores or Notifiers

> Q: I want to add another store front to be supported. How do I do that?

You will need to implement a `Handler` and pass it to the cli accordingly.

The `Handler` is responsible for parsing the `HTML` response of the store

page and extract pricing and availability information.

> Q: I want to be notified on {service}. How do I do that?

You will need to implement the `Notifier` interface and expose it to the

entrypoint accordingly along with passing in any constructor args from `settings.yaml`.

The `Notifier` is responsible for processing and grouping items as needed and

sending them upon scraping completion.