[doc] Updated README
This commit is contained in:
parent
9f391c06c7
commit
403cd18b07
3 changed files with 13 additions and 12 deletions
18
README.md
18
README.md
|
@ -2,16 +2,18 @@
|
|||
|
||||
## Utilisation
|
||||
|
||||
Pour démarrer, il vous faudra vous procurer un compte sur le [portail Opendata](https://cts-strasbourg.eu/fr/portail-open-data/) de la CTS. Après avoir obtenu un compte vous pourrez obtenir une clé d'API, qui sera à renseigner dans un fichier `.env`.
|
||||
|
||||
### Téléchargement des données
|
||||
|
||||
La version actuelle ne télécha rge pas en continue les données. Il faut utiliser le script `download_data.py` pour le faire.
|
||||
|
||||
### Lancement d'un serveur HTTP
|
||||
Pour démarrer, créez un virtual env puis installez les dépendances :
|
||||
|
||||
```sh
|
||||
python3 -m http.server
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Lancement du serveur HTTP
|
||||
|
||||
```sh
|
||||
fastapi run main.py
|
||||
```
|
||||
|
||||
## License
|
||||
|
|
3
main.py
3
main.py
|
@ -18,11 +18,10 @@ async def lifespan(_: FastAPI) -> AsyncIterator[None]:
|
|||
FastAPICache.init(InMemoryBackend())
|
||||
yield
|
||||
|
||||
load_dotenv()
|
||||
|
||||
CTS_TOKEN = os.getenv('CTS_TOKEN')
|
||||
|
||||
load_dotenv()
|
||||
|
||||
app = FastAPI(lifespan=lifespan)
|
||||
|
||||
# Récupérer les lignes de tram depuis l'opendata de l'eurométropole
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
fastapi==0.115.4
|
||||
fastapi_cache==0.1.0
|
||||
fastapi[standard]==0.115.4
|
||||
fastapi-cache2[memcache]==0.2.2
|
||||
python-dotenv==1.0.1
|
||||
requests==2.32.3
|
||||
|
|
Loading…
Add table
Reference in a new issue