Trois une enveloppe facile à utiliser pour l'API Open311
Télécharger maintenant

Trois Classement & Résumé

Trois Mots clés

Bibliothèque Python Python API

Trois La description

Trois est une wrapper open311 open311 mise à jour qui a été construite pour être aussi absolue et conviviale que possible. Beaucoup de décisions de conception effectuées refléteront ces qualités.L'installationCette est toujours une uvre en cours, mais vous pouvez git clone ce repo et exécuter python setup.py Installer pour vérifier les progrès actuels. L'emballage est également disponible via PYPI - mais L'installation via PIP n'est actuellement pas informée tant qu'elle ne se trouve que dans un état de la production. PIP Installez Threesettingsapi KeyIF Vous avez une touche API Open311 que vous avez toujours l'intention d'utiliser, plutôt que d'initialiser la trois classe avec elle à chaque fois, vous pouvez définir une open311_api_key. Variable d'environnement sur la ligne de commande.export open311_api_key = "my_api_key" Sinon, vous pouvez initialiser la classe avec votre clé d'API et votre point d'extrémité. >>> à partir de trois importations trois >>> T = trois ('api.city.gov', API_KEY = 'my_api_key') httpsby par défaut, trois configureront une URL sans un schéma spécifié à utiliser https. >>> T = trois ('api.city.gov') >>> T.endpoint == 'https: // API .City.gov / 'trueFormatThe le format par défaut pour les trois wrapper est JSON - bien que tout open311 implique Les permutations le soutiennent. Ceci est fait principalement pour une utilisation facile (rappelez-vous que c'est l'objectif trop cambriolant des trois wrapper). Vous pouvez toutefois demander spécifiquement d'utiliser XML comme format de choix. >>> T = trois ('api.city.gov', format = 'xml') >>> T.format == 'xml'trueuquageConfigurore J'ai initialisé votre classe trois, vous pouvez réajuster ses paramètres avec la méthode de configuration. Vous pouvez également revenir aux réglages orginaux avec la méthode de réinitialisation. >>> à partir de trois importations trois >>> T = trois ('api.city.gov', apié_key = 'secret_key') >>> T.Services () {'Service': 'Data'} >>> T.Configure ('Open311.sfgov.org/dev/v2/', Format = 'XML' ... API_KEY = 'SF_OPEN311_API_KEY') >>> T.Services ( ) {'SF': {'Service': 'Data'}}}}}}}} >> T.Configure (API_KEY = 'API_KEY =' "autre_api_key ') >>> Numéro de retour à Paramètres d'origine .... T.Reset () Découverte Utilisez la découverte du service Open311, invoquez simplement la méthode de découverte. >>> T = trois ('api.city.gov') >>> T.Discovery () {'Service': {'Discovery': 'Data'}} Parfois, cependant, les chemins de découverte de service diffèrent des chemins d'URL de service et de la demande - auquel cas vous pouvez transmettre l'URL spécifiée à la méthode de découverte comme argument. >>> T.Discovery ('http://another.path.gov /Discovery.json' )ServiceSto Voir les services disponibles fournis par une implémentation Open311, utilisez la méthode Services. >>> T = trois ('api.city.gov') >>> T.Services () {"Tout": {'Service_code': 'Info'}} Vous pouvez Spécifiez également un code de service spécifique pour obtenir des informations sur. >>> T.Services ('033') {'033': {'Service_code': 'Info'}} requisto Voir les données de demande disponibles, utilisez la méthode des demandes. >> > T = trois ('API.CITY.GOV') >>> T.RQUESTS () {'TOUT': {'Demandes': 'DATA'}} La plupart des implémentations Open311 Page de support et page_SIser les paramètres. >>> T. Demandes (page_size = 50) {'Total': {'de': {'50': 'Demandes'}}} >>> T.Request (page = 2, page_size = 50) {'Suivant': {'50 ':' Résultats '}} Vous pouvez également spécifier un code de service spécifique. >>> T.RQUESTS (' 123 ') {' 123 ': {' Demandes ': "Données"}} Les autres paramètres peuvent également être transmis en tant que mot-clé Arguments. >>> T.RQuillests ('456', Status = 'Open') {'456': {'Open': {'Open': {'Demandes': 'Data'}}} DemandeSIF Vous recherchez des informations sur un Open311 Demande (et vous avez son identifiant de code de service), vous pouvez utiliser la méthode de la demande. >>> T = trois ('api.city.gov') >>> T.Request ('12345') {'Demande': {'Service_code_id': {'12345': 'Data'}}}} PostsOMEDITIONS Vous devrez peut-être créer de manière programmable une nouvelle demande, qui est wha t La méthode postale peut être utilisée pour. Remarque: l'Open311 Spec Spec indique que toutes les demandes de service post-service nécessitent une clé d'API valide. >>> T = trois ('api.city.gov', apié_key = 'secret_key') >>> Tost ('123', nom = 'Zach williams', adresse = '852nd st ', ... Description =' Nouveau code de service 123 Demande. ') {' Nouvelle ': {' Demande ':' Créé '}} Tokeneach Service Demande ID de demande peut être suivie avec un jeton temporaire. Si vous avez besoin de trouver l'ID de demande de service et que vous pouvez utiliser le jeton de la demande, vous pouvez utiliser la méthode de jeton. >>> T = trois ('API.CITY.GOV') >>> T.Token ('12345') {' Service_request_id ': {' pour ': {' Jeton ':' 12345 '}}} Page d'accueil du produit

Trois Logiciels associés