Ebay Multilocation Item Notifier

Searches the ebay API for items located within a set of postcodes using the ebaysdk-python and sends an email summarising results.

Usage may include searching for items along a transportation route.

Set-up

This is built using python 3.8.

# Clone the repository
$ git clone https://github.com/dalepotter/ebay_multilocation_item_notifier.git
$ cd ebay_multilocation_item_notifier

# Set up and activate a virtual environment
$ python3 -m venv pyenv
$ source pyenv/bin/activate

# Install as a package
$ pip install -r requirements.txt

# Set environment variables
$ export OFFICE_POSTCODE='<Enter postcode>'
$ export HOME_POSTCODE='<Enter postcode>'
$ export EMAIL_SENDER_NAME='<Enter sender name>'
$ export EMAIL_SENDER_ADDRESS='<Enter email sender address>'
$ export EMAIL_RECIPIENT_NAME='<Enter email recipient name>'
$ export EMAIL_RECIPIENT_ADDRESS='<Enter email recipient address>'
$ export EMAIL_SMTP_HOST='<Enter email stmp host>'
$ export EMAIL_SMTP_USERNAME='<Enter email smtp username>'
$ export EMAIL_SMTP_PASSWORD='<Enter email smtp password>'

Customising searches for keywords/locations

An entirely new keyword search must subclass ebay_multilocation_item_notifier.keyword_search.KeywordSearch. It must include class attributes of:

• search_keyword (string, the keyword used for finding items)
• search_filters (dict with kay/value pairs of available item filters)
• search_locations (list of tuples (Location name, UK location postcode, search radius in miles (optional))).

The optional remove_duplicates (boolean) attribute willy only output an item at the first location where it is found.

Example:

class Bike(KeywordSearch):
    """Set up a search that can be expected to return a large number of items."""

    search_keyword = "(bike, bicycle)"
    search_filters = {"MaxPrice": 1000}
    search_locations = [
        #  (Location name, UK location postcode, search radius in miles (optional))
        ("London Charing Cross Station", "WC2N 5HF"),
        ("Birmingham New Street Station", "B2 4QA", 20),
        ("Edinburgh Waverley Station", "EH8 8DL"),
    ]

The search object must be added/appended to the KeywordSearchContainer in ebay_multilocation_item_notifier/item_notifier.py.

Example:

items = KeywordSearchContainer(Bike)

Running the item notifier

The following command will make ebay API calls for items at each defined postcode. The compiled results will be sent the email address defined in the EMAIL_RECIPIENT_ADDRESS environment variable.

$ python ebay_multilocation_item_notifier/item_notifier.py

Tests

Unit tests can be run using Pytest:

# Install dev requirements
$ pip install -r requirements_dev.txt

# Run the tests (that don't use the real eBay API)
$ pytest -m 'not uses_ebay_api'

# Run all the tests (including those that use the real eBay API)
$ pytest

Roadmap

• Query eBay API for defined keywords at defined location postcodes
• Send notification email daily
• Add support for removing duplicate items
• Add distance from station to seller postcode (displayed in email after item title) - approaches here
• Display only new items in email - implies storing item numbers seen
• Display location in email where a duplicate email is closest to