# udata-transport
This plugin acts as a bridge between [udata][] and [transport.data.gouv.fr](https://transport.data.gouv.fr/) system.
## Compatibility
**udata-transport** requires Python 3.7+ and [udata][].
## Installation
Install [udata][].
Remain in the same virtual environment (for Python).
Install **udata-transport**:
```shell
pip install udata-transport
```
Modify your local configuration file of **udata** (typically, `udata.cfg`) as following:
```python
PLUGINS = ['transport']
TRANSPORT_DATASETS_URL = 'https://path/to/transport.data.gouv.fr/datasets/api'
```
- `TRANSPORT_DATASETS_URL`: The URL of the API endpoint listing datasets on transport.data.gouv.fr. _Default_: `https://transport.data.gouv.fr/api/datasets`
## Usage
### Mapping dataset
The mapping is done by a job, runnable by hand or scheduled.
The job is idempotent, previous URLs are cleaned before mapping new ones.
```shell
udata job run map-transport-datasets
```
This plugin will store the mapping URL in the dataset extras `transport:url` key:
```json
{
"id": "dataset-id",
"extras": {
"transport:url": "https://path/to/datasets"
}
}
```
[udata]: https://github.com/opendatateam/udata
# Changelog
## 1.0.1 (2024-02-15)
- Replace mongo legacy image in CI [#2](https://github.com/opendatateam/udata-transport/pull/2)
- Clear datasets only after successful request [#3](https://github.com/opendatateam/udata-transport/pull/3)
## 1.0.0 (2022-03-31)
- Initial version of udata-transport [#1](https://github.com/opendatateam/udata-transport/pull/1)
Raw data
{
"_id": null,
"home_page": "https://github.com/opendatateam/udata-transport",
"name": "udata-transport",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "udata transport",
"author": "Opendata Team",
"author_email": "opendatateam@data.gouv.fr",
"download_url": "",
"platform": null,
"description": "# udata-transport\n\nThis plugin acts as a bridge between [udata][] and [transport.data.gouv.fr](https://transport.data.gouv.fr/) system.\n\n## Compatibility\n\n**udata-transport** requires Python 3.7+ and [udata][].\n\n## Installation\n\nInstall [udata][].\n\nRemain in the same virtual environment (for Python).\n\nInstall **udata-transport**:\n\n```shell\npip install udata-transport\n```\n\nModify your local configuration file of **udata** (typically, `udata.cfg`) as following:\n\n```python\nPLUGINS = ['transport']\nTRANSPORT_DATASETS_URL = 'https://path/to/transport.data.gouv.fr/datasets/api'\n```\n\n- `TRANSPORT_DATASETS_URL`: The URL of the API endpoint listing datasets on transport.data.gouv.fr. _Default_: `https://transport.data.gouv.fr/api/datasets`\n\n## Usage\n\n### Mapping dataset\n\nThe mapping is done by a job, runnable by hand or scheduled.\nThe job is idempotent, previous URLs are cleaned before mapping new ones.\n\n```shell\nudata job run map-transport-datasets\n```\n\nThis plugin will store the mapping URL in the dataset extras `transport:url` key:\n\n```json\n{\n\"id\": \"dataset-id\",\n\"extras\": {\n \"transport:url\": \"https://path/to/datasets\"\n }\n}\n```\n\n[udata]: https://github.com/opendatateam/udata\n\n# Changelog\n\n## 1.0.1 (2024-02-15)\n\n- Replace mongo legacy image in CI [#2](https://github.com/opendatateam/udata-transport/pull/2)\n- Clear datasets only after successful request [#3](https://github.com/opendatateam/udata-transport/pull/3)\n\n## 1.0.0 (2022-03-31)\n\n- Initial version of udata-transport [#1](https://github.com/opendatateam/udata-transport/pull/1)\n\n",
"bugtrack_url": null,
"license": "GNU AGPLv3+",
"summary": "Transport.data.gouv.fr mapping to Udata",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/opendatateam/udata-transport"
},
"split_keywords": [
"udata",
"transport"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "04fdc638e489fa9cd054c701bf7ac28eb79417839367700a210fbf6cb71e556e",
"md5": "72e963bee2cf6de3189950fa7f38a7b8",
"sha256": "986266b8142f898d24fcbf2c38549588d750c553c165f7d23e87e0e7011e9a31"
},
"downloads": -1,
"filename": "udata_transport-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72e963bee2cf6de3189950fa7f38a7b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6241,
"upload_time": "2024-02-15T17:25:30",
"upload_time_iso_8601": "2024-02-15T17:25:30.190362Z",
"url": "https://files.pythonhosted.org/packages/04/fd/c638e489fa9cd054c701bf7ac28eb79417839367700a210fbf6cb71e556e/udata_transport-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 17:25:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opendatateam",
"github_project": "udata-transport",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "udata-transport"
}
JSON
