maxime.friess/cts-map
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[doc] Updated README

Browse source
This commit is contained in:
Maxime FRIESS 2024-10-29 19:31:57 +01:00
parent 9f391c06c7
commit 403cd18b07
Signed by: Maxime FRIESS
GPG key ID: 5294B3B26FA19584
3 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -2,16 +2,18 @@
## Utilisation ## 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`. Pour démarrer, créez un virtual env puis installez les dépendances :
### 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
```sh ```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 ## License

3
main.py
View file

@ -18,11 +18,10 @@ async def lifespan(_: FastAPI) -> AsyncIterator[None]:
FastAPICache.init(InMemoryBackend()) FastAPICache.init(InMemoryBackend())
yield yield
load_dotenv()
CTS_TOKEN = os.getenv('CTS_TOKEN') CTS_TOKEN = os.getenv('CTS_TOKEN')
load_dotenv()
app = FastAPI(lifespan=lifespan) app = FastAPI(lifespan=lifespan)
# Récupérer les lignes de tram depuis l'opendata de l'eurométropole # Récupérer les lignes de tram depuis l'opendata de l'eurométropole

4
requirements.txt
View file

@ -1,4 +1,4 @@
fastapi==0.115.4 fastapi[standard]==0.115.4
fastapi_cache==0.1.0 fastapi-cache2[memcache]==0.2.2
python-dotenv==1.0.1 python-dotenv==1.0.1
requests==2.32.3 requests==2.32.3