OpenElections元数据API的PythonAPI包装器。
openelections-metadata的Python项目详细描述
#元数据
一个python库,它为[openelections metadata api](http://docs.openelections.net/metadata-api/)提供了一个瘦包装,其中包含有关选举以及结果数据的性质和可用性的信息。[api为各个状态提供json端点](http://blog.openelections.net/an-improved-metadata-api/),元数据提供了一种在状态中搜索和筛选选举的方法。
元数据已在Python2.7.x下测试。
##安装
` pip install openelections-metadata `
##用法
元数据提供两个类,请求和选择,用于访问api中的信息。您不需要api密钥。
###请求
要发出请求,您需要指定感兴趣的状态以及三个可选参数中的任何一个或全部:开始日期、结束日期和偏移量。元数据使用这两个日期作为范围;它将在开始日期当天或之后以及结束日期当天或之前搜索选举。例如,要申请2014年在马里兰州举行的选举,请执行以下操作:
`python >>> import metadata >>> r = metadata.Request('MD','2014-01-01') `
请求对象保留有关参数的详细信息,并在需要时保存api url和json响应。对请求对象调用parse方法将创建单独的election对象,这些对象具有与api相同的属性,只需添加一个-它具有我们在数据处理管道中使用的生成的文件名属性。
`python >>> elections = r.parse() >>> elections[0] <metadata.election.Election object at 0x103ffff10> >>> elections[0].start_dateu'2014-11-04' >>> elections[0].race_type u'general' `
##运行测试
` python setup.py test `
##问题
要报告错误或请求功能,请[创建新问题](https://github.com/openelections/metadata/issues)描述情况,并尽可能提供详细信息。我们欢迎您的贡献:请随意分叉代码并提交pull请求。
许可证
元数据是根据mit许可证发布的。