Official data.public.lu theme for uData 1.1.0
Clone or download
Latest commit e4e8a8e Nov 13, 2018
Permalink
Failed to load latest commit information.
.circleci Use assets manifest and udata 1.6 theme changes Oct 15, 2018
assets Fix resources display Jul 30, 2018
docker Generic harvester using a CSV file as source , applied to IGSS May 8, 2018
gouvlu Update to version 1.1.7.dev for next development cycle Oct 23, 2018
requirements udata version fix Nov 13, 2018
tests Adds FAQ, usage, strategy... pages and add more tests Feb 26, 2018
.dockerignore Initial Commit from cookiecutter Jul 6, 2017
.gitignore Use assets manifest and udata 1.6 theme changes Oct 15, 2018
.nvmrc Initial assets build Nov 30, 2017
CHANGELOG.md Update to version 1.1.7.dev for next development cycle Oct 23, 2018
MANIFEST.in actually include all files in wheel ! Aug 10, 2017
README.md Document the translation process Jan 22, 2018
babel.cfg Handle both plugin and theme translations (fix #46, fix #49) Feb 12, 2018
bumpr.rc Added bumpr config Nov 30, 2017
coverage.rc Automate with invoke Nov 30, 2017
crowdin.yml Update Crowdin configuration file Feb 8, 2018
docker-compose.yml Enable flask development mode Jul 30, 2018
package-lock.json Use assets manifest and udata 1.6 theme changes Oct 15, 2018
package.json Use assets manifest and udata 1.6 theme changes Oct 15, 2018
setup.cfg Automate with invoke Nov 30, 2017
setup.py Generic harvester using a CSV file as source , applied to IGSS May 8, 2018
tasks.py Handle both plugin and theme translations (fix #46, fix #49) Feb 12, 2018
webpack.config.js Use assets manifest and udata 1.6 theme changes Oct 15, 2018

README.md

gouvlu

Crowdin

Official udata theme of the Open Data Portal of Luxembourg

Usage

Install the theme package in you udata environement:

pip install gouvlu

Then, define the installed theme as current in you udata.cfg:

THEME = 'gouvlu'

configuration parameters

Some features are optionnal and can be enabled with the following udata.cfg parameters

  • GOUVLU_GOVBAR = True/False: Toggle the govbar

Development

There is a docker-compose configuration to get started fast. Just run:

docker-compose up

Then go to http://localhost:7000 to connect to the development server with live reload.

Local setup

If you want to execute some development tasks like extracting the translations or running the test suite, you need to install the dependencies localy (in a virtualenv).

virtualenv venv
source venv/bin/activate
pip install -r requirements/develop.pip

If you want to build assets, you also need node.js. The prefered way is with nvm:

nvm use
npm install
inv assets_build

Ok, you are ready, you can now execute some Development commands.

inv -l
Available tasks:

  all            Run tests, reports and packaging
  assets-build   Build static assets
  assets-watch   Build assets on change
  clean          Cleanup all build artifacts
  cover          Run tests suite with coverage
  dist           Package for distribution
  i18n           Extract translatable strings
  i18nc          Compile translations
  pydist         Perform python packaging (without compiling assets)
  qa             Run a quality report
  test           Run tests suite

Let's execute an entire build:

inv

Translations

This project is translated on crowdin.

To update the source string, you need to extract them with the inv i18n command and push the result on this repository. Crowding will detect the new string as soon as they are available on the master branch.

Crowdin will submit a pull-request each time some translation is submitted by the contributors.

Releasing

gouvlu uses bumpr to perform release. Simply execute:

# Install bumpr if not already installed
pip install bumpr
# Dry run to preview changes
bumpr -dv
# Perform release
bumpr

Bumpr will execute test, package everything, update changelog, handle tagging and push to upstream repository... You just have to wait for the build to succeed and your release is available.