Skip to main content

Automate your grocery shop.

Project description

autogroceries

test_deploy pypi

autogroceries simplifies grocery shopping by using Playwright to automate the addition of ingredients to your basket.

Installation

I recommend using uv to manage the python version, virtual environment and autogroceries installation:

uv venv --python 3.13
source .venv/bin/activate
uv pip install autogroceries
# Install Chromium browser binary required for playwright.
playwright install chromium

Usage

autogroceries uses Playwright to interface with the Sainsbury's website, automatically filling your cart with an inputted list of ingredients.

autogroceries is designed to be used as a CLI tool, with a single command:

 autogroceries --help
Usage: autogroceries [OPTIONS]

  Automate your grocery shopping using playwright.

  Please set the [STORE]_USERNAME and [STORE]_PASSWORD in a .env file in the
  same directory you run autogroceries. Replace [STORE] with the store name in
  caps e.g. SAINSBURYS_USERNAME.

Options:
  --store [sainsburys|waitrose]  The store to shop at.  [required]
  --ingredients-path PATH        Path to csv file (without header) detailing
                                 ingredients. Each line should be in the
                                 format 'ingredient,quantity' e.g. 'eggs,2'.
                                 [required]
  --log-path PATH                If provided, will output shopping log to this
                                 path.
  --help                         Show this message and exit.

The autogroceries CLI expects a .env file in the same directory from where you execute the command. This .env will be loaded by python-dotenv and should define the "[STORE]_USERNAME" and "[STORE]_PASSWORD" variables, with "[STORE]" replaced by the name of the store in uppercase, for instance:

# .env
SAINSBURYS_USERNAME=your_username
SAINSBURYS_PASSWORD=your_password

Demo: autogroceries in action

Your browser does not support the video tag.

Disclaimer

autogroceries is developed for educational use only. Users are responsible for:

  • Following website's robots.txt and Terms of Service.
  • Using appropriate delays and respecting rate limits.
  • Complying with applicable laws.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autogroceries-2.2.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autogroceries-2.2.1-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file autogroceries-2.2.1.tar.gz.

File metadata

  • Download URL: autogroceries-2.2.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for autogroceries-2.2.1.tar.gz
Algorithm Hash digest
SHA256 89d7f4b9aea068aac914a3cba767738d13612722ded1cd20a0e28d3759ea50e5
MD5 a9cb74947d720e524fba1b7c83d0fde4
BLAKE2b-256 e51c62cacab830af965273fccbf6e95abf6ab5de4eaf10147c218961c4da68ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for autogroceries-2.2.1.tar.gz:

Publisher: test_deploy.yml on dzhang32/autogroceries

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file autogroceries-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: autogroceries-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for autogroceries-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd5e51373663f4fe2b90b7537aa20316fd093cb557c8ad32ec48fac714f7b5ce
MD5 818a910f2740cc83255998fb265b9309
BLAKE2b-256 57e342ba2c350e35572f09b214177edf5c1d57a03d0ce3265128ba688d02579c

See more details on using hashes here.

Provenance

The following attestation bundles were made for autogroceries-2.2.1-py3-none-any.whl:

Publisher: test_deploy.yml on dzhang32/autogroceries

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page