Validata Web API
Project description
Validata API
Web API for Validata
Usage
You can use the online instance of Validata:
- user interface: https://go.validata.fr/
- API: https://go.validata.fr/api/v1/
- API docs: https://go.validata.fr/api/v1/apidocs
Several software services compose the Validata stack. The recommended way to run it on your computer is to use Docker. Otherwise you can install each component of this stack manually, for example if you want to contribute by developing a new feature or fixing a bug.
Run with Docker
Read instructions at https://git.opendatafrance.net/validata/validata-docker
Develop
Install
We recommend using venv python standard package:
python -m venv .venv
source .venv/bin/activate
Install the project dependencies (using master branch of validata-core project):
pip install -r requirements.txt
pip install -e .
To use a specific distant git development branch of validata_core :
pip install -r requirements.txt
pip uninstall validata_core
pip install git+https://git.opendatafrance.net/validata/validata-core.git@development-branch
pip install -e .
Configure
cp .env.example .env
Customize the configuration variables in .env file.
Do not commit .env.
See also: https://github.com/theskumar/python-dotenv
Serve
Start the web server...
./serve.sh
... then open http://localhost:5600/
Test the API - example for schema of Infrastructures de recharge pour véhicules électriques
Schema used: https://schema.data.gouv.fr/schemas/etalab/schema-irve/2.1.0/schema.json
Validate data (case-sensitive validation of headers):
Validate data (case-insensitive validation of headers):
Release a new version
- Update version in setup.py and CHANGELOG.md files
- Commit changes using
Releaseas commit message - Create git tag (starting with "v" for the release)
- Git push:
git push && git push --tagss - Check that container image is well built and pypi package is created (validata-api pipelines)
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 Distribution
Built Distribution
Hashes for Validata_API-0.7.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c574ca1f887962b11f7d254aba08bc3f6b37a71f9858e375cf110fbdda680b1c |
|
| MD5 | bdf249dc4a39d9d09acfda182307eb5c |
|
| BLAKE2b-256 | b9ce57aff283a4add93a7941d55bf71d36370f85f4f36860e354d3e8a23b4b91 |
