From 83eb85aea8dd449c75574dfb37de5ff5955ab102 Mon Sep 17 00:00:00 2001
From: yu23ki14 <yuki_021423@yahoo.co.jp>
Date: Tue, 9 Jul 2024 18:45:44 +0900
Subject: [PATCH] readme and .env

---
 etl/.env.example |  1 +
 etl/README.md    | 24 ++++++++++++++++++++++++
 2 files changed, 25 insertions(+)
 create mode 100644 etl/.env.example
 create mode 100644 etl/README.md

diff --git a/etl/.env.example b/etl/.env.example
new file mode 100644
index 0000000..3d2cf0e
--- /dev/null
+++ b/etl/.env.example
@@ -0,0 +1 @@
+X_BEARER_TOKEN=
\ No newline at end of file
diff --git a/etl/README.md b/etl/README.md
new file mode 100644
index 0000000..ce6fca3
--- /dev/null
+++ 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
+```