https://github.com/chartes/dico-topo-app
API de l’application DicoTopo (https://dicotopo.cths.fr/)
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.5%) to scientific vocabulary
Keywords
Repository
API de l’application DicoTopo (https://dicotopo.cths.fr/)
Statistics
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 9
- Releases: 0
Topics
Metadata Files
README.md
The DicoTopo application API
Description
This repository contains the API service code for https://dicotopo.cths.fr.
Prerequisite - Install Elasticsearch
Install Elasticsearch and its ICU plugin
:warning: Use an ES version compatible with requirements.txt
:informationsource: Below commands are run independently/outside virtual environments (deactivate)
- Elasticsearch: refer to your organisation instructions or Elasticsearch guidelines
- ICU plugin: check if ICU is installed with uconv -V, otherwise:
folder/bin/elasticsearch-plugin install analysis-icupath/to/elasticsearch
Local deployment
With docker (security disabled):
docker run --name es-project_name -d -p 9200:9200 -e "discovery.type=single-node" -e "xpack.security.enabled=false" -e "xpack.security.http.ssl.enabled=false" elasticsearch:8.12.1
docker exec es-project_name bash -c "bin/elasticsearch-plugin install analysis-icu"
docker restart es-project_name
Install
- Clone the GitHub repository in your projects folder:
bash cd path/to/projects_folder/ git clone https://github.com/chartes/encpos-app.git
- Clone the GitHub repository in your projects folder:
```bash cd path/to/projects_folder/ git clone https://github.com/chartes/encpos-app.git ```- Set up the virtual environment in the app folder:
bash cd path/to/projects_folder/encpos-app python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt
For servers requiring uWSGI to run Python apps (remote Nginx servers):
- check if uWSGI is installed pip3 list --local
- install it in the virtual env if it's not: pip3 install uWSGI.
NB : cette commande peut nécessiter d'installer wheel :
- pour vérifier si wheel est installé : pip3 show wheel
- pour l'installer le cas échéant : pip3 install wheel
- Install Elasticsearch and create indices if they are not available:
Follow the ES installation & initial indexing instructions below
2) Start the server in debug mode:
python flask_app.py
3) Then visit http://127.0.0.1:5003/dico-topo/api/1.0?capabilities to get infos about the API capabilities
more info about the configuration of ES: https://jolicode.com/blog/construire-un-bon-analyzer-francais-pour-elasticsearch
How to reindex all indexable data, referencing a localhost api:
python manage.py db-reindex --host=http://localhost --delete=1
Owner
- Name: École nationale des chartes
- Login: chartes
- Kind: organization
- Location: 65 rue de Richelieu, 75002 Paris
- Website: http://www.chartes.psl.eu/
- Repositories: 12
- Profile: https://github.com/chartes
Grand établissement d’enseignement supérieur dédié à la recherche historique
GitHub Events
Total
- Push event: 5
- Pull request event: 1
- Create event: 1
Last Year
- Push event: 5
- Pull request event: 1
- Create event: 1