qwantresearch/alwilda repository overview

⁠alwilda

Alwilda is an API around Geo services.

For the moment it provides only one route /v1/instant_answer to check if a query is an address.

⁠Architecture

Alwilda has been made with api star⁠

The address caracterization uses addr_detector⁠ for the adress detection.

⁠Installation

Alwilda depends on python 3.6 and pipenv⁠.

Before installing the dependencies you need libpostal and fasttext

⁠Installation of Postal:

Before you install Postal, make sure you have the following prerequisites:

sudo apt-get install curl autoconf automake libtool pkg-config g++ python3.6-dev

Then to install the C library:

git clone https://github.com/openvenues/libpostal
cd libpostal
./bootstrap.sh
./configure --datadir=[...some dir with a few GB of space...]
make
sudo make install

# On Linux it's probably a good idea to run
sudo ldconfig

⁠Installation of FastText

In order to build fastText, use the following:

git clone https://github.com/facebookresearch/fastText.git
cd fastText
make

⁠pip dependencies

To install the dependencies just run: pipenv install

⁠Running the API

apistar run

You can then query it:

curl 'http://localhost:8080/v1/instant_answer?q=1%20Avenue%20des%20Champs-Élysées%20Paris'

⁠Running the tests

apistar test

⁠Using the API

⁠routes

⁠GET /v1/instant_answer

This API detects if a query is an address. It has one parameter, q for the query

It returns a response in json:

⁠Name

The API is named after Alwilda, a 5th-century Scandinavian female pirate. If you have never heard of her, you should search for her in Qwant⁠ ;)