Canadian Tracker

Canadian Tracker tracks the inventory and prices of your favorite canadian retailer using the internal API that powers CanadianTire.ca.

Due to the design of the Canadian Tire API and its relatively poor performance, it does so in multiple steps implemented as the following commands: scrape-products, scrape-skus, and scrape-prices.

Use --help on any of the commands for more information on their role and options.

Getting Started

Canadian Tracker uses poetry to manage its Python dependencies. As such, you can easily run the project from the development tree:

# Install all dependencies to a virtual environment
$ poetry install

You then need to initialize the database, using alembic:

$ CTRACKER_DB_PATH=inventory.sqlite poetry run alembic upgrade head

You are then ready to start scraping the inventory, to get an up-to-date list of products:

$ poetry run ctscraper scrape-products --db-path inventory.sqlite
$ poetry run ctscraper scrape-skus --db-path inventory.sqlite

Once this is done, you can scrape the prices of the products in the inventory:

$ poetry run ctscraper scrape-prices --db-path inventory.sqlite

Web Interface

There are two web frontends available:

Legacy jQuery Frontend

The legacy web interface is an npm project with its root in src/canadiantracker/web. Build it with:

$ cd src/canadiantracker/web
$ npm install
$ npm run build-dev # or build-prod

The Javascript and CSS output files will be placed in src/canadiantracker/web/dist and will be picked up by the web application.

Modern Svelte Frontend

A modern Svelte 5 frontend is available with live search, price sparklines, and responsive design. It is located in src/canadiantracker/web-svelte.

Build it with:

$ cd src/canadiantracker/web-svelte
$ npm install
$ npm run build    # Production build

For development with hot reload:

$ npm run dev

Serving the Web Interface

To serve the web interface, use uvicorn:

# Legacy frontend (default)
$ CTSERVER_SERVE_DB_PATH=inventory.sqlite poetry run uvicorn canadiantracker.http:app --host 0.0.0.0 --port 1337

# Modern Svelte frontend
$ CTSERVER_USE_SVELTE=1 CTSERVER_SERVE_DB_PATH=inventory.sqlite poetry run uvicorn canadiantracker.http:app --host 0.0.0.0 --port 1337

For production with multiple workers:

$ CTSERVER_USE_SVELTE=1 CTSERVER_SERVE_DB_PATH=inventory.sqlite poetry run uvicorn canadiantracker.http:app --host 0.0.0.0 --port 1337 --workers 4