Canary/QUICKSTART.txt at main · CanaryInAMine/Canary · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
CANARY QUICKSTART
=================

TO RUN THE APP
--------------
cd canary
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
streamlit run Home.py

(App opens at http://localhost:8501)


RETURNING TO THE APP
--------------------
After initial setup, you only need:

cd canary
source .venv/bin/activate
streamlit run Home.py

(On Windows: .venv\Scripts\activate instead of source .venv/bin/activate)


TO ENABLE ALL SCRAPERS (OPTIONAL)
---------------------------------
Some state scrapers (Illinois, Minnesota) require Playwright browser
automation due to bot protection on their websites.

playwright install

This downloads Chromium (~400MB). Without it:
- Illinois scraper: Returns only 10 providers (first page)
- Minnesota scraper: Returns no data

Other scrapers (Colorado, Alabama, Virginia) work without Playwright.


TO RUN TESTS
------------
pip install -r requirements-dev.txt
pytest

(Run specific tests with: pytest tests/test_analysis/)


TO RUN LINTING/TYPE CHECKING
----------------------------
ruff check .
ruff format .
mypy src/


TO SET UP PRE-COMMIT HOOKS
--------------------------
pip install pre-commit
pre-commit install