Search and consult CADA advices
Project description
CADA
A simplistic interface to search and consult CADA advices.
This is the engine behind https://cada.data.gouv.fr.
Compatibility
CADA has been tested on Python 3.7, MongoDB 4.1 and ElasticSearch 7.2.
The ElasticSearch ICU Analysis plugin is required.
You can install it with:
elasticsearch-plugin install analysis-icu
Installation
You can install Cada with pip:
$ pip install cada
You need to create the cada working directory, denoted by $HOME in this documentation:
$ mkdir -p $HOME && cd $HOME
$ vim cada.cfg # See configuration
$ wget https://cada.data.gouv.fr/export -O data.csv
$ cada load data.csv # Load initial data
$ cada static # Optional: collect static assets for proper caching
$ cada runserver
local development environment
Please make sure you are in a clean virtualenv.
$ git clone https://github.com/etalab/cada
$ cd cada
$ docker-compose up -d
$ pip install -e .
$ wget https://cada.data.gouv.fr/export -O data.csv
$ cada load data.csv
$ cada reindex
$ cada runserver
Configuration
All configuration is done through the cada.cfg file in $HOME.
It's basically a Python file with constants defined in it:
SERVER_NAME: the public server name. Mainly used in emails.SECRET_KEY: the common crypto hash. e.g. sessions.openssl rand -hex 24should be a good start.ELASTICSEARCH_URL: the ElasticSearch server URL inhost:portformat. Default tolocalhost:9200if not setMONGODB_SETTINGS: a dictionary to configure MongoDB. Default to{'DB': 'cada'}. See the official flask-mongoengine documentation for more details.
Mails
Mail server configuration is done through the following variables:
MAIL_SERVER: SMTP server hostname. Default tolocalhost.MAIL_PORT: SMTP server port. Default to25.MAIL_USE_TLS: activate TLS. Default toFalse.MAIL_USE_SSL: activate SSL. Default toFalse.MAIL_USERNAME: optional SMTP server username.MAIL_PASSWORD: optional SMTP server password.MAIL_DEFAULT_SENDER: Sender email used for mailings. Default tocada@localhost.ANON_ALERT_MAIL: destination mail for anonymisation alerts. Default tocada.alert@localhost.
See the official Flask-Mail documentation for more details.
Sentry
There is an optional support for Sentry. You need to install the required dependencies:
$ pip install raven[flask]
# Or to install it with cada
$ pip install cada[sentry]
You need to add your Sentry DSN to the configuration
SENTRY_DSN = 'https://xxxxx:xxxxxx@sentry.mydomain.com/id'
Piwik
There is an optional Piwik support. You simply need to add your Piwik server URL and your Piwik project ID to the configuration:
PIWIK_URL = 'piwik.mydomain.com'
PIWIK_ID = X
Current (in progress)
- Nothing yet
1.0.0 (2019-07-19)
- Add a
burnthemallcommand #25 - Use
tqdmfor major commands with loops #25 - Python 3 #28
- Elastic Search 7.2 #29
- Mongo 4.1 #29
- Improved pseudonymization #32
- Display sample of api calls #33
- Fix text query #33
0.2.1 (2019-07-15)
- Fix advice part roman numerals handling #13
- Colorize advices labels #14
- Fixes about page #11
- Fix the cli encoding handling as well as some formatting issues #18
- Footer fixes (svg logo, alignments, https links) #20
- Upgrade jQuery, Bootstrap and Flatly assets and fixes responsive layout #21
- Fix unicode issue #26
0.2.0 (2018-10-05)
- Upgrade stack to latest dependencies (Flask 1.0 with
flask.cli, pytest...) #6 - Test and fix alert mails #7
- Added "about" page #9
- Handle type IV advices #10
0.1.0 (2014-04-14)
- Initial release
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file cada-1.0.1.dev146-py3-none-any.whl.
File metadata
- Download URL: cada-1.0.1.dev146-py3-none-any.whl
- Upload date:
- Size: 436.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bc5e6e5f443e392dbdc3e5139935ddc3076856ef97aa7f8680f519222534f10f |
|
| MD5 | 3b647e2103e541bacd0b2d9e3e598f98 |
|
| BLAKE2b-256 | 99bd2ef2a30a112d3f98d215abab0e65609b39e8c063dd45af29827c042b24ef |
