três um wrapper fácil de usar para a API Open311
Baixe Agora

três Classificação e resumo

três Tag

Biblioteca Python. Pitão API.

três Descrição

Três é um wrapper atualizado Open311 API Python que foi construído para ser tão absoluto amigável e fácil de usar quanto possível. Muitas das decisões de design feitas irão refletir essas qualidades.InstallationThis ainda é um trabalho em andamento, mas você pode clonar este repo e executar o Python Setup.py Instalar para verificar o progresso atual. O invólucro também está disponível através do Pypi - mas A instalação do PIP não é aconselhada até que esteja em um estado pronto de produção.PIP Install ThreesettingSapi Keyif Você tem uma chave API Open311 que você sempre pretende usar, em vez de inicializar as três aulas a cada vez, você pode definir um Open311_api_key Variável de ambiente na linha de comando.Export open311_api_key = "my_api_key" Caso contrário, você pode inicializar a classe com sua chave de API e ponto final. >>> de três importação três >>> t = três ('api.city.gov', api_key = 'my_api_key') httpsby padrão, três irão configurar um URL sem um esquema especificado para usar https. >>> t = três ('api.city.gov') >>> t.endpoint == 'https: // API .city.gov / 'TrueFormatThe formato padrão para o wrapper três é JSON - Embora nem todo o Aberto311 impl as etes apoiam isso. Isso é feito principalmente para fácil de usar (lembre-se, esse é o objetivo excessivo do wrapper três). Você pode, no entanto, solicitar especificamente para usar o XML como seu formato de escolha. >>> t = três ('api.city.gov', format = 'xml') >>> t.format == 'xml'trueusageConfiguroe-ter você "Inicializou suas três classes, você pode reajustar suas configurações com o método Configurar. Você também pode voltar para as configurações orginais com o método de reset. >>> a partir de três importação três >>> t = três ('api.city.gov', api_key = 'secret_key') >>> t.services () {'serviço': 'Data'} >>> t.configure ('open311.sfgov.org/dev/v2/', format = 'xml' ... api_key = 'sf_open311_api_key') >>> t.services ( ) {'SF': {'serviço': 'Data'}} >>> t.configure (api_key = 'outro_api_key') >>> # alternar para as configurações originais .... t.reset () ordem de descoberta para Use a descoberta de serviço Open311, simplesmente invocar o método de descoberta. >>> t = três ('api.city.gov') >>> t.discovery () {'serviço': {'descoberta': 'Data'}} Às vezes, no entanto, os caminhos de descoberta de serviço diferem do serviço e solicitam caminhos de URL - nesse caso, você pode passar o URL especificado para o método de descoberta como um argumento. >>> T.Discovery ('http://another.path.gov /discovery.json')servicesto Veja os serviços disponíveis fornecidos por uma implementação Open311, use o método de serviços. >>> t = três ('api.city.gov') >>> t.services () {'tudo': {'service_code': 'Info'}} você pode Especifique também um código de serviço específico para obter informações sobre. >>> t.services ('033') {'033': {'service_code': 'Informações'}} solicitaTo Consulte os dados de solicitação disponíveis, use o método de solicitações. >> > t = três ('api.city.gov') >>> t.Requests () {'tudo': {'Solicitações': 'Data'}} a maioria das implementações Open311 Suporte e página_size Parâmetros. >>> t. solicitações (Page_Size = 50) {'Total': {'de': {'50': 'solicitações'}}} >>> t.requests (página = 2, página_size = 50) {'próximo': {'50 ':' Resultados '}} Você também pode especificar um código de serviço específico. >>> T.Requests (' 123 ') {' 123 ': {' solicitações ':' Data '}} Outros parâmetros também podem ser passados como palavra-chave argumentos. >>> T.Requests ('456', status = 'aberto') {'456': {'Abrir': {'solicitações': 'Data'}}} solicitar que você esteja procurando informações sobre um Solicitação Open311 (e você tem o ID do código de serviço), você pode usar o método de solicitação. >>> t = três ('api.city.gov') >>> t.request ('12345') {'pedido': {'service_code_id': {'12345': 'Data'}}} pós-pós-metima você pode precisar programaticamente criar um novo pedido, que é wha o método post pode ser usado para. Nota: O SPEC do Open311 que todas as solicitações de serviço pós exigem uma chave de API válida. >>> t = três ('api.city.gov', api_key = 'secret_key') >>> t.post ('123', nome = 'Zach Williams', endereço = '852nd st ', ... Description =' Novo código de serviço 123 Solicitar. ') {' Novo ': {' solicitação ':' criado '}} ID de solicitação de serviço tokenach pode ser rastreado com um token temporário. Se você precisar encontrar o ID de solicitação de serviço e ter o token da solicitação, você poderá usar o método token. >>> t = três ('api.city.gov') >>> t.token ('12345') {' service_request_id ': {' para ': {' token ':' 12345 '}}} página inicial do produto

três Software Relacionado