Une bibliothèque Python pour utiliser l'API What3Words REST.
Testé avec Python 2.7, 3.4, 3,5, 3,6 (Vérifiez la construction Travis-Ci.org)
La bibliothèque Python What3words vous donne un accès programmatique
Pour utiliser cette bibliothèque, vous aurez besoin d'une clé API, veuillez visiter https://what3words.com/select-plan et inscrivez-vous à un compte.
Pour installer What3Words, simplement:
$ pip install what3words
Installation de la dernière version de GitHub:
$ git clone https://github.com/what3words/w3w-python-wrapper.git
$ cd w3w-python-wrapper
$ python setup.py install
Cette fonction prend le paramètre des mots comme une chaîne de 3 mots 'table.book.chair'
La charge utile retournée de la méthode convert-to-coordinates
est décrite dans la documentation de l'API What3Words REST.
Cette fonction prend la latitude et la longitude:
lat=0.1234
, lng=1.5678
La charge utile retournée de la méthode convert-to-3wa
est décrite dans la documentation de l'API What3Words REST.
Renvoie une liste de 3 adresses Word en fonction de l'entrée utilisateur et d'autres paramètres.
Cette méthode fournit des corrections pour les types d'erreur d'entrée suivants:
La méthode autosuggest
détermine les corrections possibles à la chaîne d'adresses de mot fournie fournie en fonction de la probabilité des erreurs d'entrée énumérées ci-dessus et renvoie une liste de suggestions classée. Cette méthode peut également prendre en considération la proximité géographique des corrections possibles à un emplacement donné pour améliorer encore les suggestions renvoyées.
Vous ne recevrez des résultats que si la chaîne d'adresses de 3 mots partielle que vous soumettez contient les deux premiers mots et au moins le premier caractère du troisième mot; Sinon, un message d'erreur sera renvoyé.
Nous fournissons diverses politiques clip
pour vous permettre de spécifier une zone géographique utilisée pour exclure les résultats qui ne sont pas susceptibles d'être pertinents pour vos utilisateurs. Nous vous recommandons d'utiliser le paramètre clip
pour donner un ensemble de résultats plus ciblé et plus court à votre utilisateur. Si vous connaissez l'emplacement actuel de votre utilisateur, nous vous recommandons également fortement d'utiliser l' focus
pour retourner les résultats susceptibles d'être plus pertinents.
En résumé, la politique clip
est utilisée pour restreindre éventuellement la liste des résultats des candidats Autosugest, après quoi, si l'accent a été fourni, cela sera utilisé pour classer les résultats par ordre de pertinence pour l'objectif.
https://docs.what3words.com/api/v3/#autosuggest
La charge utile retournée de la méthode autosuggest
est décrite dans la documentation de l'API What3Words REST.
Renvoie une section de la grille de 3M x 3M What3words pour une boîte de délimitation.
Récupère une liste des langages d'adresse de 3 mots actuellement chargés et disponibles.
La charge utile retournée de la méthode available-languages
est décrite dans la documentation de l'API What3Words REST.
Cette méthode prend une chaîne en tant que paramètre et renvoie si la chaîne est dans le format d'un 3WA (par exemple «rempli.count.soap»). Le type de retour est booléen. Remarque: ne vérifie pas s'il s'agit d'un 3WA existant réel.
isPossible3wa(“filled.count.soap”) returns True
isPossible3wa(“not a 3wa”) returns False
isPossible3wa(“not.3wa address”) returns False
Cette méthode prend une chaîne en tant que paramètre et recherche la chaîne pour toutes les instances possibles d'un 3WA - par exemple "laisser dans mon porche à word.word.word". Susceptible d'être la principale méthode appelée sur les notes de livraison. Renvoie un tableau d'articles correspondants. Renvoie un tableau vide si aucune correspondance n'est trouvée. Remarque: ne vérifie pas s'il s'agit d'un 3WA existant réel.
findPossible3wa(“Please leave by my porch at filled.count.soap”) will return [‘filled.count.soap’]
findPossible3wa(“Please leave by my porch at filled.count.soap or deed.tulip.judge”) will return [‘filled.count.soap’, ‘deed.tulip.judge’]
findPossible3wa(“Please leave by my porch at”) will return []
Cette méthode prend une chaîne en tant que paramètre et la passe d'abord via le filtre Regex W3W (comme l'appel ISPOSIBLE3WA () sur la chaîne), puis appelle l'API W3W pour vérifier qu'il s'agit d'un vrai 3WA.
isValid3wa(“filled.count.soap”) returns True
isValid3wa(“filled.count.”) returns False
isValid3wa(“python.is.cool”) returns False
Pour le stockage sûr de votre clé API sur votre ordinateur, vous pouvez définir cette clé API en utilisant les variables d'environnement de votre système.
$ export W3W_API_KEY= < Secret API Key >
import what3words
from os import environ
api_key = environ [ 'W3W_API_KEY' ]
w3w = what3words . Geocoder ( api_key )
res = w3w . convert_to_coordinates ( 'prom.cape.pump' )
print ( res )
import what3words
from os import environ
api_key = environ [ 'W3W_API_KEY' ]
w3w = what3words . Geocoder ( api_key )
res = w3w . convert_to_3wa ( what3words . Coordinates ( 51.484463 , - 0.195405 ))
print ( res )
Trouver un bug ou demander une nouvelle fonctionnalité? Veuillez nous le faire savoir en soumettant un problème.
Tout le monde et tout le monde est invité à contribuer.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)v3.3.0
30/09/24 - Prise en charge des paramètres régionaux, mise à jour regex, format et testsv3.2.0
08/03/22 - Ajout de fonctions Regexv3.1.1
04/10/19 - Correction des bogues liés à la définition de la valeur du langage par défaut et du type d'entrée AutoSuggestv3.1.0
29/08/19 - Prise en charge du paramètre «préférée» pour les appels Autosuggestv3.0.2
16/07/19 - Inclure l'utilisateur-agent dans les demandes d'APIv3.0.0
04/02/19 - Wrapper mis à jour pour utiliser l'API What3words V3v2.2.1
08/09/17 - Python 3 Installation de configuration fixe grâce à @joedborgv2.2.0
07/09/17 - Python 3 Support, grâce à @joedborgv2.1.1
07/09/17 - Mettre à jour Readme: cette bibliothèque est compatible avec Python 2v2.1.0
28/03/17 - Ajout de la version multilingue de autosuggest
et standardblend
v2.0.2
27/10/16 - Publié sur PYPIv2.0.0
10/06/16 - Wrapper mis à jour pour utiliser l'API What3Words V2 La licence du MIT (MIT)
Une copie de la licence est disponible dans le fichier de licence du référentiel.