Uma biblioteca Python para usar a API REST WHAT3WORDS.
Testado com Python 2.7, 3.4, 3.5, 3.6 (verifique o travis-ci.org build)
A biblioteca What3Words Python oferece acesso programático a
Para usar esta biblioteca, você precisará de uma chave da API, visite https://what3words.com/select-plan e inscreva-se em uma conta.
Para instalar o What3Words, simplesmente:
$ pip install what3words
Instalando a versão mais recente do GitHub:
$ git clone https://github.com/what3words/w3w-python-wrapper.git
$ cd w3w-python-wrapper
$ python setup.py install
Esta função leva o parâmetro das palavras como uma string de 3 palavras 'table.book.chair'
A carga útil devolvida do método convert-to-coordinates
é descrita na documentação da API What3Words REST.
Esta função leva a latitude e a longitude:
lat=0.1234
, lng=1.5678
A carga útil devolvida do método convert-to-3wa
é descrita na documentação da API What3Words REST.
Retorna uma lista de endereços de 3 palavras com base na entrada do usuário e em outros parâmetros.
Este método fornece correções para os seguintes tipos de erro de entrada:
O método autosuggest
determina possíveis correções na sequência de endereço de 3 palavras fornecida com base na probabilidade dos erros de entrada listados acima e retorna uma lista classificada de sugestões. Esse método também pode levar em consideração a proximidade geográfica de possíveis correções a um determinado local para melhorar ainda mais as sugestões retornadas.
Você receberá apenas os resultados se a sequência de endereço de 3 palavras parcial que você enviar contiver as duas primeiras palavras e pelo menos o primeiro caractere da terceira palavra; caso contrário, uma mensagem de erro será retornada.
Fornecemos várias políticas clip
para permitir que você especifique uma área geográfica usada para excluir resultados que provavelmente não sejam relevantes para seus usuários. Recomendamos que você use o parâmetro clip
para fornecer um conjunto mais direcionado e mais curto de resultados ao seu usuário. Se você conhece o local atual do seu usuário, também recomendamos que você use o focus
para retornar os resultados que provavelmente serão mais relevantes.
Em resumo, a política clip
é usada para restringir opcionalmente a lista de resultados de sugestões automáticas do candidato, após o que, se o foco tiver sido fornecido, isso será usado para classificar os resultados em ordem de relevância para o foco.
https://docs.what3words.com/api/v3/#autosuggest
A carga útil devolvida do método autosuggest
é descrita na documentação da API What3Words REST.
Retorna uma seção da grade de 3m x 3m What3words para uma caixa delimitadora.
Recupera uma lista das linguagens de endereço de 3 palavras atualmente carregadas e disponíveis.
A carga útil devolvida do método available-languages
é descrita na documentação da API What3Words REST.
Este método pega uma sequência como um parâmetro e retorna se a string está no formato de um 3WA (por exemplo, “preenchido.count.soap”). O tipo de retorno é booleano. NOTA: Não verifique se é um 3WA existente real.
isPossible3wa(“filled.count.soap”) returns True
isPossible3wa(“not a 3wa”) returns False
isPossible3wa(“not.3wa address”) returns False
Este método pega uma sequência como um parâmetro e pesquisa a string por possíveis instâncias de um 3WA - por exemplo, "Saia na minha varanda em word.word.word." É provável que seja o principal método que é chamado nas notas de entrega. Retorna uma variedade de itens correspondentes. Retorna uma matriz vazia se não forem encontradas correspondências. NOTA: Não verifique se é um 3WA existente real.
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 []
Este método pega uma sequência como um parâmetro e o passa primeiro pelo filtro W3W Regex (semelhante ao chamado ispossível3wa () na sequência) e depois chama a API W3W para verificar se é um 3WA real.
isValid3wa(“filled.count.soap”) returns True
isValid3wa(“filled.count.”) returns False
isValid3wa(“python.is.cool”) returns False
Para armazenamento seguro da sua chave de API no seu computador, você pode definir essa chave da API usando as variáveis de ambiente do seu sistema.
$ 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 )
Encontre um bug ou deseja solicitar um novo recurso? Informe -nos enviando um problema.
Qualquer um e todo mundo pode contribuir.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)v3.3.0
30/09/24 - Suporte Locale, Atualizar Regex, Formato e Testesv3.2.0
08/03/22 - Funções regex adicionadasv3.1.1
04/10/19 - Corrija bugs relacionados à definição do valor padrão da linguagem e do tipo de entrada automáticav3.1.0
29/08/19 - Suporte parâmetro 'prefer -land' para chamadas de auto -sugestõesv3.0.2
16/07/19 - Inclua o agente de usuário em solicitações de APIv3.0.0
04/02/19 - Wrapper atualizado para usar o What3Words API V3v2.2.1
08/09/17 - Instalação do Python 3v2.2.0
07/09/17 - Suporte Python 3, graças a @joedborgv2.1.1
07/09/17 - ATUALIZAÇÃO README: Esta biblioteca é compatível com Python 2v2.1.0
28/03/17 - Versão multilíngue adicionada do autosuggest
e standardblend
v2.0.2
27/10/16 - Publicado no Pypiv2.0.0
10/06/16 - Wrapper atualizado para usar o What3Words API V2 A licença do MIT (MIT)
Uma cópia da licença está disponível no arquivo de licença do repositório.