From: Alain Vagner <alain.vagner@sous-anneau.org>
To: ~etalab/codegouvfr-devel@lists.sr.ht
Cc: Alain Vagner <alain.vagner@sous-anneau.org>
Subject: [PATCH] added installation instructions
Date: Mon, 29 Nov 2021 17:27:39 +0100
Message-Id: <20211129162739.61578-1-alain.vagner@sous-anneau.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 09400c0..99a5014 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,20 @@ csv](https://git.sr.ht/~etalab/codegouvfr-fetch-data/tree/master/item/platforms.
 of supported platforms, we collect the data we need for
 [code.gouv.fr](https://code.gouv.fr).
 
+# Installation and configuration
+
+1. Clone this repository: `git clone https://git.sr.ht/~etalab/codegouvfr-fetch-data && cd codegouvfr-fetch-data`
+2. Install Python dependencies: `pip install -r requirements.txt`
+3. [Create a GitHub Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+4. Create an account on [libraries.io](https://libraries.io/) and create an API key on your [account page](https://libraries.io/account).
+5. Set the following environment variables: GITHUB_TOKEN and LIBRARIESIO_API_KEY. Ex: `export GITHUB_TOKEN="your github token" ; export LIBRARIESIO_API_KEY="your libraries.io api key"`
+6. Create the folders that will receive the output data: `mkdir -p data/organizations/csv && mkdir -p data/organizations/json && mkdir -p data/repositories/csv && mkdir -p data/repositories/json && mkdir -p data/libraries/csv && mkdir -p data/libraries/json`
+7. Check the content of the `platforms.csv` file and update its content if needed.
+
+# Generate JSON and CSV files
+
+Launch the script with `python fetch.py`. The output files will be available in the subfolders of `data`.
+
 ## Todo
 
 We aim at collecting data from more forges:
-- 
2.30.0