Initial commit

README.md

+# Siretor API - API légère de sirétisation
+
+La sirétisation consiste à recherche le code SIRET d'un établissement dans la base SIRENE de l'INSEE.
+
+La recherche s'effectue en combinant recherches floues et exactes:
+- nom de l'établissement (floue)
+- adresse (floue)
+- code postal (exacte en "commence par")
+- code activité NAF (exact en "commence par")
+- code SIREN de l'unité légale (exacte)
+- code commune figurant dans le Code Officiel Géographique de l'INSEE (exacte)
+- catégorie d'entreprise (exacte)
+
+## Architecture
+
+Les données géocodées de la base SIRENE sont importées dans une base postgresql.
+
+Les recherches textuelles floues (nom, adresse) s'appuient sur les trigrammes fournis par l'extension pg_trgm de postgresql.
+
+Les requêtes SQL sont préparées par le code python, qui expose l'API à l'aide de falcon et gunicorn.
+
+## Installation
+
+Télécharger et importer les données dans postgresql à l'aide de :
+
+`bash siretor.sh`
+
+Lancer l'API via gunicorn à l'aide de :
+
+`gunicorn siretor:app`
+
+## Utilisation de l'API
+
+
+## Todo
+
+- ajouter un critère de distance géographique
+- migrer vers fast-api pour auto-générer l'interface swagger