summaryrefslogtreecommitdiff
path: root/python-validata-api.spec
diff options
context:
space:
mode:
authorCoprDistGit <infra@openeuler.org>2023-05-10 08:35:19 +0000
committerCoprDistGit <infra@openeuler.org>2023-05-10 08:35:19 +0000
commit683a258da9f45b519fb09306f30081863f363639 (patch)
tree5e3a689281716479583cf7e3047f84040cd14030 /python-validata-api.spec
parentcd9e623e36871c1be9960a97507ab7548e5537a4 (diff)
automatic import of python-validata-api
Diffstat (limited to 'python-validata-api.spec')
-rw-r--r--python-validata-api.spec374
1 files changed, 374 insertions, 0 deletions
diff --git a/python-validata-api.spec b/python-validata-api.spec
new file mode 100644
index 0000000..ffa07d5
--- /dev/null
+++ b/python-validata-api.spec
@@ -0,0 +1,374 @@
+%global _empty_manifest_terminate_build 0
+Name: python-Validata-API
+Version: 0.7.4
+Release: 1
+Summary: Validata Web API
+License: AGPLv3
+URL: https://git.opendatafrance.net/validata/validata-api
+Source0: https://mirrors.nju.edu.cn/pypi/web/packages/2c/88/095a161f1cab5a84cd4e129341e4aeffea58d90eb0ee1791d95e56a3fb6e/Validata-API-0.7.4.tar.gz
+BuildArch: noarch
+
+Requires: python3-apispec
+Requires: python3-cachetools
+Requires: python3-flask
+Requires: python3-flask-cors
+Requires: python3-flask-matomo
+Requires: python3-flasgger
+Requires: python3-marshmallow
+Requires: python3-dotenv
+Requires: python3-requests
+Requires: python3-toml
+Requires: python3-toolz
+Requires: python3-ujson
+Requires: python3-shapely
+Requires: python3-validata-core
+
+%description
+# Validata API
+
+[![PyPI](https://img.shields.io/pypi/v/validata-api.svg)](https://pypi.python.org/pypi/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:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+Install the project dependencies (using master branch of validata-core project):
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+To use a specific distant git development branch of validata_core :
+```bash
+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
+
+```bash
+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...
+
+```bash
+./serve.sh
+```
+
+... then open http://localhost:5600/
+
+### Test the API - example for schema of Infrastructures de recharge pour véhicules électriques
+
+File to validate: https://opendata.paris.fr/explore/dataset/belib-points-de-recharge-pour-vehicules-electriques-donnees-statiques/download?format=csv&timezone=Europe/Berlin&use_labels_for_header=false
+
+Schema used: https://schema.data.gouv.fr/schemas/etalab/schema-irve/2.1.0/schema.json
+
+Validate data (case-sensitive validation of headers):
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse&header_case=True
+
+
+
+Validate data (case-insensitive validation of headers):
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse&header_case=False
+
+## Release a new version
+
+- Update version in [setup.py](setup.py) and [CHANGELOG.md](CHANGELOG.md) files
+- Commit changes using `Release` as 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](https://git.opendatafrance.net/validata/validata-api/-/pipelines))
+
+
+
+
+%package -n python3-Validata-API
+Summary: Validata Web API
+Provides: python-Validata-API
+BuildRequires: python3-devel
+BuildRequires: python3-setuptools
+BuildRequires: python3-pip
+%description -n python3-Validata-API
+# Validata API
+
+[![PyPI](https://img.shields.io/pypi/v/validata-api.svg)](https://pypi.python.org/pypi/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:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+Install the project dependencies (using master branch of validata-core project):
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+To use a specific distant git development branch of validata_core :
+```bash
+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
+
+```bash
+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...
+
+```bash
+./serve.sh
+```
+
+... then open http://localhost:5600/
+
+### Test the API - example for schema of Infrastructures de recharge pour véhicules électriques
+
+File to validate: https://opendata.paris.fr/explore/dataset/belib-points-de-recharge-pour-vehicules-electriques-donnees-statiques/download?format=csv&timezone=Europe/Berlin&use_labels_for_header=false
+
+Schema used: https://schema.data.gouv.fr/schemas/etalab/schema-irve/2.1.0/schema.json
+
+Validate data (case-sensitive validation of headers):
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse&header_case=True
+
+
+
+Validate data (case-insensitive validation of headers):
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse&header_case=False
+
+## Release a new version
+
+- Update version in [setup.py](setup.py) and [CHANGELOG.md](CHANGELOG.md) files
+- Commit changes using `Release` as 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](https://git.opendatafrance.net/validata/validata-api/-/pipelines))
+
+
+
+
+%package help
+Summary: Development documents and examples for Validata-API
+Provides: python3-Validata-API-doc
+%description help
+# Validata API
+
+[![PyPI](https://img.shields.io/pypi/v/validata-api.svg)](https://pypi.python.org/pypi/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:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+Install the project dependencies (using master branch of validata-core project):
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+To use a specific distant git development branch of validata_core :
+```bash
+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
+
+```bash
+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...
+
+```bash
+./serve.sh
+```
+
+... then open http://localhost:5600/
+
+### Test the API - example for schema of Infrastructures de recharge pour véhicules électriques
+
+File to validate: https://opendata.paris.fr/explore/dataset/belib-points-de-recharge-pour-vehicules-electriques-donnees-statiques/download?format=csv&timezone=Europe/Berlin&use_labels_for_header=false
+
+Schema used: https://schema.data.gouv.fr/schemas/etalab/schema-irve/2.1.0/schema.json
+
+Validate data (case-sensitive validation of headers):
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse&header_case=True
+
+
+
+Validate data (case-insensitive validation of headers):
+
+http://localhost:5600/validate?schema=https%3A%2F%2Fschema.data.gouv.fr%2Fschemas%2Fetalab%2Fschema-irve%2F2.1.0%2Fschema.json&url=https%3A%2F%2Fopendata.paris.fr%2Fexplore%2Fdataset%2Fbelib-points-de-recharge-pour-vehicules-electriques-donnees-statiques%2Fdownload%3Fformat%3Dcsv%26timezone%3DEurope%2FBerlin%26use_labels_for_header%3Dfalse&header_case=False
+
+## Release a new version
+
+- Update version in [setup.py](setup.py) and [CHANGELOG.md](CHANGELOG.md) files
+- Commit changes using `Release` as 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](https://git.opendatafrance.net/validata/validata-api/-/pipelines))
+
+
+
+
+%prep
+%autosetup -n Validata-API-0.7.4
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+ find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+ find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+ find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+ find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+ find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-Validata-API -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.4-1
+- Package Spec generated