121 lines
3.9 KiB
Markdown
121 lines
3.9 KiB
Markdown
# coach-scraper
|
|
|
|
**Caution! Be careful running this script.**
|
|
|
|
We intentionally delay each batch of requests. Make sure any adjustments to this
|
|
script appropriately rate-limit.
|
|
|
|
## Overview
|
|
|
|
This is a simple web scraper for coaches listed on:
|
|
|
|
* [chess.com](https://www.chess.com/coaches)
|
|
* [lichess.org](https://www.lichess.org/coach)
|
|
|
|
The program searches for coach usernames as well as specific information about
|
|
each of them (their profile, recent activity, and stats). The result will be
|
|
found in a newly created `data` directory with the following structure:
|
|
```
|
|
data
|
|
└── <site>
|
|
│ ├── coaches
|
|
│ │ ├── <username>
|
|
│ │ │ ├── <username>.html
|
|
│ │ │ ├── export.json
|
|
│ │ │ └── ...
|
|
│ │ ├── ...
|
|
└── pages
|
|
├── <n>.txt
|
|
├── ...
|
|
```
|
|
|
|
## Usage
|
|
|
|
If you have nix available, run:
|
|
```bash
|
|
$ nix run . -- --user-agent <your-email> -s <site>
|
|
```
|
|
If not, ensure you have [poetry](https://python-poetry.org/) on your machine and
|
|
instead run the following:
|
|
```bash
|
|
$ poetry run python3 -m app -u <your-email> -s <site>
|
|
```
|
|
|
|
## Database
|
|
|
|
Included in the development shell of this flake is a [Postgres](https://www.postgresql.org/)
|
|
client (version 15.5). Generate an empty Postgres cluster at `/db` by running
|
|
```bash
|
|
$ pg_ctl -D db init
|
|
```
|
|
To start the database, run the following:
|
|
```bash
|
|
$ pg_ctl -D db -l db/logfile -o --unix_socket_directories=@scraper start
|
|
```
|
|
In the above command, `@scraper` refers to an [abstract socket name](https://www.postgresql.org/docs/15/runtime-config-connection.html#GUC-UNIX-SOCKET-DIRECTORIES).
|
|
Rename to whatever is appropriate for your use case. To then connect to this
|
|
database instance, run:
|
|
```bash
|
|
$ psql -h @scraper
|
|
```
|
|
To later shut the database down, run:
|
|
```bash
|
|
$ pg_ctl -D db stop
|
|
```
|
|
|
|
### Loading Data
|
|
|
|
To load all exported coach data into a local postgres instance, use the provided
|
|
`sql/load_export.sql` file. First concatenate all exported content:
|
|
```bash
|
|
$ cat data/{chesscom,lichess}/export.json > data/export.json
|
|
```
|
|
Then (assuming your database cluster has been initialized at `@scraper`), you
|
|
can run:
|
|
```bash
|
|
$ psql -h @scraper -f sql/load_export.sql -v export="'$PWD/data/export.json'"
|
|
```
|
|
|
|
### E2E
|
|
|
|
With the above section on loading files, we now have the individual components
|
|
necessary to scrape coach data from our chess website and dump the results into
|
|
the database in one fell swoop. Assuming our database is open with a socket
|
|
connection available at `@scraper`:
|
|
```bash
|
|
nix run . -- --user-agent <your-email> -s chesscom -s lichess
|
|
cat data/{chesscom,lichess}/export.json > data/export.json
|
|
psql -h @scraper -f sql/load_export.sql -v export="'$PWD/data/export.json'"
|
|
```
|
|
|
|
## Development
|
|
|
|
[nix](https://nixos.org/) is used for development. The included `flakes.nix`
|
|
file automatically loads in Python (version 3.11.6) with packaging and
|
|
dependency management handled by poetry (version 1.7.0). [direnv](https://direnv.net/)
|
|
can be used to a launch a dev shell upon entering this directory (refer to
|
|
`.envrc`). Otherwise run via:
|
|
```bash
|
|
$ nix develop
|
|
```
|
|
|
|
### Language Server
|
|
|
|
The [python-lsp-server](https://github.com/python-lsp/python-lsp-server)
|
|
(version v1.9.0) is included in this flake, along with the [python-lsp-black](https://github.com/python-lsp/python-lsp-black)
|
|
plugin for formatting purposes. `pylsp` is expected to be configured to use
|
|
[McCabe](https://github.com/PyCQA/mccabe), [pycodestyle](https://pycodestyle.pycqa.org/en/latest/),
|
|
and [pyflakes](https://github.com/PyCQA/pyflakes). Refer to your editor for
|
|
configuration details.
|
|
|
|
### Formatting
|
|
|
|
Formatting depends on the [black](https://black.readthedocs.io/en/stable/index.html)
|
|
(version 23.9.1) tool. A `pre-commit` hook is included in `.githooks` that can
|
|
be used to format all `*.py` files prior to commit. Install via:
|
|
```bash
|
|
$ git config --local core.hooksPath .githooks/
|
|
```
|
|
If running [direnv](https://direnv.net/), this hook is installed automatically
|
|
when entering the directory.
|