freerouting / freerouting/freerouting-python-client

Document how to use the python client with a self-hosted freerouting API

Aperta
#1 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
13
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I am running the freerouting API in a docker container. I don't see any place for creating an API key for the container. However when I use the Python library to try and connect to my API, I get an error related to api keys:

```
# Cannot set the API key to none
client = FreeroutingClient( base_url="http://localhost:37864", version="dev",api_key=None)

# ValueError: API key must be provided

# Cannot not specify the API key
client = FreeroutingClient( base_url="http://localhost:37864", version="dev")

# TypeError: FreeroutingClient.__init__() missing 1 required positional argument: 'api_key'
```

As a sanity check as well, I am definitely running the API at that port:
```
$ curl http://localhost:37864/v1/system/status
{
"status": "OK",
"cpu_load": 2.3054999620327306,
"ram_used": 18,
"ram_available": 35,
"storage_available": -411,
"session_count": 0
}%
```

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Start with the Python client's FreeroutingClient constructor and the self-hosted endpoint shown in the issue, then verify the /v1/system/status request behavior. Document how API keys work for a Docker-hosted API and show a working client connection; done means a user can follow the instructions without encountering the reported missing-key errors.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.