BirdXplorer

Description

BirdXplorer is software that helps users explore community notes data on X (formerly known as Twitter).

Example Usecase

See example

Development

Requirements

• Python (v3.10.12)
• PostgreSQL (v15.4)

Installation

pip install -e ".[dev]"

Environment Vars

cp .env.example .env

key	value
BX_STORAGE_SETTINGS__PASSWORD	birdxplorer

Testing

To run basic unit tests and some integration tests, simply run the following:

tox

For the data model testing, you need to download community notes data and store some directory (say data/20230924) and run the following:

BX_DATA_DIR=data/20230924 tox

Run Server

$ pwd
$ your_dir/BirdXplorer
$ docker-compose up -d