readme and .env

codeforjapan · Jul 9, 2024 · 83eb85a · 83eb85a
1 parent 3b51ff1
commit 83eb85a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/etl/.env.example b/etl/.env.example
@@ -0,0 +1 @@
+X_BEARER_TOKEN=
diff --git a/etl/README.md b/etl/README.md
@@ -0,0 +1,24 @@
+# BirdXplorer ETL
+
+This is an ETL to get and process data of community notes and X posts, in order to prepare API.
+
+## Setup development environment
+
+### Set setting variables
+
+```
+$ cp .env.example .env
+```
+
+| Key            | Description             |
+| -------------- | ----------------------- |
+| X_BEARER_TOKEN | API key for Twitter API |
+
+### Run
+
+```
+$ pwd
+/your_dir/BirdXplorer/etl
+$ pip install .
+$ python src/birdxplorer_etl/main.py
+```