From 4f1b2db064dfbabd7b5b1bc8a51113235ee86ba1 Mon Sep 17 00:00:00 2001
From: Millian Poquet <millian.poquet@irit.fr>
Date: Mon, 24 Jul 2023 19:39:08 +0200
Subject: [PATCH] doc: ut3 authentication
---
README.md | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 3fa29d1..d2ffe04 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ This project tries to make CELCAT usable by:
### Usage
```
-Usage: fetch-celcat [OPTIONS] COURSE_REQUEST_FILE
+Usage: fetch-celcat [OPTIONS] COURSE_REQUEST_FILE CREDENTIALS_FILE
Options:
--json, --json-raw TEXT If set, raw CELCAT events are written as JSON to this file.
@@ -23,7 +23,7 @@ Options:
--help Show this message and exit.
```
-The course request input file defines which courses you are interested in.
+**The course request input file** defines which courses you are interested in.
For example, if you give the following courses:
- BAS (apogee code KINXIB11)
@@ -41,6 +41,15 @@ KINXIB11,BAS,2022-09-05 00:00:00,2022-10-21 23:59:00,TP,INXIB11A42,3
KINXIB21,SR1,2022-09-05 00:00:00,2022-10-21 23:59:00,TP,INXIB21A42,5
```
+**The credentials input file** is a JSON file that contains your UT3 credential information, for example:
+
+```json
+{
+ "username": "YOUR_UT3_USERNAME",
+ "password": "YOUR_UT3_PASSWORD"
+}
+```
+
### Use this script with caution
The only life jacket of this script is that it prints a warning if the number of fetched events is not the expected one for each course request.
--
GitLab