ChemPare

Intro

Compares prices from chemical vendors that sell to individuals and residential addresses.

Note: This project is a work in progress, not yet in Beta mode

---

How does it work

Magic, mostly.

---

Installation

Python Enviroment Setup

Try using the Makefile (OSX)

1. Checkout this repo

git clone https://github.com/YourHeatingMantle/ChemPare.git

2. Go to repo directory and run Makefile

cd ChemPare
make install

3. Run script

make run

Manual setup

1. Install Python 3.13.1

2. Checkout this repo

git clone https://github.com/YourHeatingMantle/ChemPare.git

3. Create pyenv environment

Optional. (documentation here).

cd ./ChemPare
python3 -m venv venv

4. Go to the folder and activate the python env

On Linux/OSX:

source ./venv/bin/activate

If you're doing development work and using VSCode, then install some useful Python extensions using the code command:

code --install-extension ms-python.black-formatter
code --install-extension ms-python.debugpy
code --install-extension ms-python.python
code --install-extension ms-python.isort
code --install-extension ms-python.vscode-pylance
code --install-extension njqdev.vscode-python-typehint
code --install-extension wolfieshorizon.python-auto-venv
code --install-extension rodolphebarbanneau.python-docstring-highlighter

On Windows:

# tbd....

5. Install project packages

./venv/bin/pip install -r requirements.txt

6. Run main script, and provide a chemical name or CAS.

python3 main.py

Example output:

Unit Tests

To get the unit tests to fire, you need to install the dev packages.

On OSX:

If you're on OSX, just run make install-dev then make test.

Other OS:

1. Follow the regular install steps
2. Run the following:

./venv/bin/pip3 install --upgrade pip
./venv/bin/pip3 install -r requirements/dev.txt
. ./venv/bin/activate

3. Run the below to execute all unit tests in ./tests directory:

venv/bin/python3 -m pytest -vvv tests

The output should look simiar to the following: