This release is a pre-release and may not be stable for production use.
Api-tabular
This connects to udata-hydra and serves the converted CSVs as an API.
Run locally
Start udata-hydra via docker compose.
Launch this project:
docker compose up
You can now access the raw postgrest API on http://localhost:8080.
Now you can launch the proxy (ie the app):
poetry install
poetry run adev runserver -p8005 api_tabular/app.py # Api related to apified CSV files by udata-hydra
poetry run adev runserver -p8005 api_tabular/metrics.py # Api related to udata's metrics
And query postgrest via the proxy using a resource_id, cf below. Test resource_id is 27d469ff-9908-4b7e-a2e0-9439bb38a395
API
Meta informations on resource
curl http://localhost:8005/api/resources/27d469ff-9908-4b7e-a2e0-9439bb38a395/
{
"created_at": "2023-02-11T11:44:03.875615+00:00",
"url": "https://data.toulouse-metropole.fr//explore/dataset/boulodromes/download?format=csv&timezone=Europe/Berlin&use_labels_for_header=false",
"links": [
{
"href": "/api/resources/27d469ff-9908-4b7e-a2e0-9439bb38a395/profile/",
"type": "GET",
"rel": "profile"
},
{
"href": "/api/resources/27d469ff-9908-4b7e-a2e0-9439bb38a395/data/",
"type": "GET",
"rel": "data"
}
]
}
Profile (csv-detective output) for a resource
curl http://localhost:8005/api/resources/27d469ff-9908-4b7e-a2e0-9439bb38a395/profile/
{
"profile": {
"header": [
"geo_point_2d",
"geo_shape",
"ins_nom",
"ins_complexe_nom_cplmt",
"ins_codepostal",
"secteur",
"..."
]
},
"...": "..."
}
Data for a resource (ie resource API)
curl http://localhost:8005/api/resources/27d469ff-9908-4b7e-a2e0-9439bb38a395/data/
{
"data": [
{
"__id": 1,
"geo_point_2d": "43.58061543292057,1.401751073689455",
"geo_shape": {
"coordinates": [
[
1.401751073689455,
43.58061543292057
]
],
"type": "MultiPoint"
},
"ins_nom": "BOULODROME LOU BOSC",
"ins_complexe_nom_cplmt": "COMPLEXE SPORTIF DU MIRAIL",
"ins_codepostal": 31100,
"secteur": "Toulouse Ouest",
"quartier": 6.3,
"acces_libre": null,
"ins_nb_equ": 1,
"ins_detail_equ": "",
"ins_complexe_nom": "",
"ins_adresse": "",
"ins_commune": "",
"acces_public_horaires": null,
"acces_club_scol": null,
"ins_nom_cplmt": "",
"ins_id_install": ""
}
],
"links": {
"next": "/api/resources/60963939-6ada-46bc-9a29-b288b16d969b/data/?page=2&page_size=1",
"prev": null,
"profile": "/api/resources/60963939-6ada-46bc-9a29-b288b16d969b/profile/"
},
"meta": {"page": 1, "page_size": 1, "total": 2}
}
This endpoint can be queried with the following operators as query string:
# sort by column
column_name__sort=asc
column_name__sort=desc
# contains
column_name__contains=word
# exacts
column_name__exact=word
# less
column_name__less=12
# greater
column_name__greater=12
Pagination is made throught queries with page and page_size:
curl http://localhost:8005/api/resources/27d469ff-9908-4b7e-a2e0-9439bb38a395/data/?page=2&page_size=30
Metadata
Release files for udata-hydra-csvapi 0.1.0.dev222
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| udata_hydra_csvapi-0.1.0.dev222.tar.gz | 7.3 kB | Without provenance | Details for udata_hydra_csvapi-0.1.0.dev222.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| udata_hydra_csvapi-0.1.0.dev222-py3-none-any.whl | Python 3 | none | any | Details for udata_hydra_csvapi-0.1.0.dev222-py3-none-any.whl |
Total release size: 15.6 kB
Release files / udata_hydra_csvapi-0.1.0.dev222.tar.gz
| Download URL | udata_hydra_csvapi-0.1.0.dev222.tar.gz |
|---|---|
| Size | 7.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
69c720c1d40456a5d5939a5f6ce444dcec384fcafd4dd1d9b5265a4f49f2c7d3
|
|
BLAKE2b-256 checksum How to use checksums |
b85b20afd8521f854b24822cc291cdb644c1af9c6d59f256a57527fefe4cf40a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.9.15 Linux/5.15.0-1039-aws
|
Release files / udata_hydra_csvapi-0.1.0.dev222-py3-none-any.whl
| Download URL | udata_hydra_csvapi-0.1.0.dev222-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4d2c46070d98544cd1a0fc326392d6bb5e97a593f683c1694baf3d03fbf2822b
|
|
BLAKE2b-256 checksum How to use checksums |
9e304198d9c83a708a9be2e7b80979e74e65711e54a6c49d7c7e7cfc1eef9617
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.9.15 Linux/5.15.0-1039-aws
|
Security for udata-hydra-csvapi 0.1.0.dev222
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.