Metadata-Version: 2.1
Name: udata-schema-gouvfr
Version: 1.2.0
Summary: Integration with schema.data.gouv.fr
Home-page: https://github.com/etalab/udata-schema-gouvfr
Author: Etalab
Author-email: pypi@data.gouv.fr
License: MIT
Keywords: udata,schema,tableschema
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Environment :: Web Environment
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Software Distribution
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: udata (>=2.1.4.dev)
Requires-Dist: requests
Provides-Extra: test
Requires-Dist: httpretty (==0.9.7) ; extra == 'test'
Requires-Dist: mock (==3.0.5) ; extra == 'test'
Requires-Dist: pytest-flask (==0.15.0) ; extra == 'test'
Requires-Dist: pytest-sugar (==0.9.2) ; extra == 'test'
Requires-Dist: pytest (==4.6.3) ; extra == 'test'

# udata-schema-gouvfr

This udata plugin provides an integration with [schema.data.gouv.fr](https://schema.data.gouv.fr)

## Features

- Adds a schema button to resources with a schema
- Displays a modal when clicking this button providing links to documentation and validation


## Usage

Install the plugin package in your udata environment:

```bash
pip install udata-schema-gouvfr
```

Then activate it in your `udata.cfg`:

```python
PLUGINS = ['schema-gouvfr']
```

## Configuration

You can control this plugin behavior with the following `udata.cfg` parameters:

- **`SCHEMA_GOUVFR_VALIDATA_URL`**: the URL to your [Validata](https://validata.fr/) instance (without trailing slash). **ex:** `https://validata.etalab.studio`
- **`SCHEMA_GOUVFR_IRVE_STABLE_RESOURCE_URL`**: the permalink to the consolidated [IRVE dataset](irve-dataset)'s latest resource. **ex:** `https://www.data.gouv.fr/fr/datasets/r/50625621-18bd-43cb-8fde-6b8c24bdabb3`

## Jobs

This plugin declares jobs.

- **`udata job run set-irve-schemas`**: sets the `schema` attribute of resources that are consolidated as part of [the national IRVE dataset](irve-dataset)


[irve-dataset]: https://www.data.gouv.fr/fr/datasets/fichier-consolide-des-bornes-de-recharge-pour-vehicules-electriques/

# Changelog

## 1.2.0 (2020-10-16)

- Link to datasets with the same schema from the schema modal [#4](https://github.com/etalab/udata-schema-gouvfr/pull/4)

## 1.1.0 (2020-08-25)

- Add a job to set the `schema` attribute to the IRVE schema on multiple resources [#3](https://github.com/etalab/udata-schema-gouvfr/pull/3)

## 1.0.0 (2020-08-05)

Initial release



