datasette-enrichments-opencage

使用OpenCage进行地理编码增强

安装

在Datasette相同的环境中安装此插件。

datasette install datasette-enrichments-opencage

用法

此插件通过使用OpenCage Geocoder添加地理编码增强。

您需要从OpenCage获取API密钥 - 您可以在https://opencagedata.com/users/sign_up注册免费试用。

筛选您希望进行地理编码的数据，然后应用OpenCage地理编码增强。

您需要指定传递给地理编码器的模板，指定哪些模板应作为输入使用。

如果您有一个包含地址的单列，可以使用此模板

{{ address }}

如果您有分开的列用于街道、城市、州和国家，可以使用此模板

{{ street }}, {{ city }}, {{ state }}, {{ country }}

如果您地址列缺少国家，但所有地址都在美国，可以使用此模板

{{ address }}, USA

有关如何获取最佳结果的提示，请参阅OpenCage指南。

默认情况下，仅将地理编码器的纬度和经度存储在您的表的latitude和longitude列中。如果尚未存在，则将创建这些列。

您可以指定一个列来存储地理编码器的完整JSON输出。如果不存在，则也会创建此列。

完整的JSON格式在此描述中。

配置

您可以使用此插件而不进行配置，但每次运行增强时都需要输入您的API密钥。

为了避免这种情况，您可以像这样将API密钥设置为插件配置

export OPENCAGE_API_KEY="your-api-key"

然后在 metadata.yml 中

plugins:
  datasette-enrichments-opencage:
    api_key:
      $env: OPENCAGE_API_KEY

然后这样运行 Datasette

datasette mydatabase.db -m metadata.yml --root

这将为您提供登录“root”用户的URL，该用户可以访问增强功能。

开发

要本地设置此插件，首先检出代码。然后创建一个新的虚拟环境

cd datasette-enrichments-opencage
python3 -m venv venv
source venv/bin/activate

现在安装依赖项并测试依赖项

pip install -e '.[test]'

要运行测试

pytest