Skin and customization for the French opendata portal based on uData.
HTML Python CSS JavaScript
Clone or download
Permalink
Failed to load latest commit information.
.circleci
.tx Initial import Apr 29, 2014
requirements Switch lo local.test Jun 23, 2018
theme
udata_gouvfr Ajout de l'arrêté SPD du 14 juin 2017 Jul 5, 2018
.gitignore
.nvmrc
.pyup.yml Added pyup configuration Feb 5, 2018
CHANGELOG.md Ajout de l'arrêté SPD du 14 juin 2017 Jul 5, 2018
MANIFEST.in Packaging improvements (#131) Oct 25, 2016
README.md [doc] Quick start for a project from scratch Dec 15, 2017
babel.cfg Split plugin and theme translations and improve i18n task Feb 12, 2018
bumpr.rc
coverage.rc Added theme tests May 8, 2014
crowdin.yml Update Crowdin configuration file Feb 12, 2018
package.json Dataset recommendations (#243) Jan 16, 2018
pep8.rc Initial import Apr 29, 2014
setup.cfg
setup.py Prepare for legacy PyPI closure and PyPI warehouse supporting markdown Apr 16, 2018
tasks.py Prepare for legacy PyPI closure and PyPI warehouse supporting markdown Apr 16, 2018
tox.ini
webpack.config.js Remove reco code from this repo (#294) Apr 12, 2018
webpack.config.prod.js Use webpack and npm Jul 10, 2015

README.md

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