tap-lichess is a Singer tap for Lichess.

Built with the Meltano Tap SDK for Singer Taps.

Currently supported:

• Users
• Games

There are plenty more interesting data sources available from the API. PRs accepted if this tap doesn't include what you need.

Install from GitHub:

pipx install git+/~https://github.com/ORG_NAME/tap-lichess.git@v1.0.0

{
  "usernames": ["VincentKeymer2004"], // A list of player's games to download
  "auth_token": "<personal access token>", // optional
}

A full list of supported settings and capabilities for this tap is available by running:

tap-lichess --about

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

You can generate a personal access token from your account settings. Authentication is not required, but authenticating will increase rate limits. preference:read is the only required permission.

You can easily run tap-lichess by itself or in a pipeline using Meltano.

tap-lichess --version
tap-lichess --help
tap-lichess --config CONFIG --discover > ./catalog.json

Follow these instructions to contribute to this project.

pipx install poetry
poetry install

Create tests within the tap_lichess/tests subfolder and then run:

poetry run pytest

You can also test the tap-lichess CLI interface directly using poetry run:

poetry run tap-lichess --help

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-lichess
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-lichess --version
# OR run a test `elt` pipeline:
meltano elt tap-lichess target-jsonl

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.