freerouting / freerouting/freerouting-python-client

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

Abierto
#1 0 comentarios 1 reacción 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
13
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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
}%
```

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.