uData customizations for Data.gouv.fr


Keywords
udata opendata portal etalab, opendata, python, udata, udata-gouvfr
License
Other
Install
pip install udata-gouvfr==1.4.1

Documentation

uData-gouvfr

Build status Join the chat at https://gitter.im/etalab/udata-gouvfr

uData customizations for Etalab / Data.gouv.fr.

Note: This is a uData extension, you should read the uData documentation first.

Compatibility

udata-gouvfr requires Python 2.7+ and uData.

Installation

Install uData.

Remain in the same Python virtual environment and install udata-gouvfr:

pip install udata-gouvfr

Create a local configuration file udata.cfg in your udata directory (or where your UDATA_SETTINGS point out) or modify an existing one as following:

PLUGINS = ['gouvfr']
THEME = 'gouvfr'

Development

Prepare a udata development environment.

It is recommended to have a workspace with the following layout:

$WORKSPACE
├── fs
├── udata
│   ├── ...
│   └── setup.py
├── udata-gouvfr
│   ├── ...
│   └── setup.py
└── udata.cfg

The following steps use the same Python virtual environment and the same version of npm (for JS) as udata.

Clone the udata-gouvfr repository into your workspace and install it in development mode:

git clone https://github.com/etalab/udata-gouvfr.git
pip install -e udata-gouvfr

Modify your local udata.cfg configuration file as following:

PLUGINS = ['gouvfr']
THEME = 'gouvfr'

You can execute udata-gouvfr specific tasks from the udata-gouvfr directory.

ex: Build the assets:

cd udata-gouvfr
npm install
inv assets-build

You can list available development commands with:

inv -l