Anchor Connector

这是一个连接非官方Anchor API的简单库。
它可以用来从https://anchor.fm/dashboard的仪表板中导出数据。

支持端点

• total_plays
• plays_by_age_range
• plays_by_app
• plays_by_device
• plays_by_episode
• plays_by_gender
• plays_by_geo
• plays_by_geo_city
• episodes

对于每个剧集，以下端点都受到支持

• episode_plays
• episode_performance
• episode_aggregated_performance
• episode_all_time_video_data

请参见__main.py__以查看所有端点。

凭证

在使用此库之前，您必须从仪表板提取您的Anchor凭证；它们不会通过您的Anchor设置暴露。

您可以使用我们的web-extension或查看代码以了解如何手动完成。

安装

pip install anchorconnector

作为库的使用

from anchorconnector import AnchorConnector

connector = AnchorConnector(
   base_url=BASE_URL,
   webstation_id=WEBSTATION_ID,
   anchorpw_s=ANCHOR_PW_S,
)

end = datetime.now()
start = end - timedelta(days=30)

total_plays = connector.total_plays(True)
logger.info("Podcast Total Plays = {}", json.dumps(total_plays, indent=4))

plays_by_age_range = connector.plays_by_age_range(start, end)
logger.info(
   "Plays by Age Range = {}",
   json.dumps(plays_by_age_range, indent=4),
)

# plays_by_app = connector.plays_by_app(start, end)
# plays_by_device = connector.plays_by_device(start, end)
# plays_by_episode = connector.plays_by_episode(start, end)
# plays_by_gender = connector.plays_by_gender(start, end)
# plays_by_geo = connector.plays_by_geo()
# plays_by_geo_city = connector.plays_by_geo_city("Germany")
# ...


for episode in connector.episodes():
   logger.info("Episode = {}", json.dumps(episode, indent=4))

   web_episode_id = episode["webEpisodeId"]

   episode_meta = connector.episode_plays(web_episode_id)
   logger.info("Episode Metadata = {}", json.dumps(episode_meta, indent=4))

   # ...

请参见__main.py__以查看所有端点。

开发

我们使用Pipenv进行虚拟环境和开发依赖管理。安装Pipenv后

1. 在开发模式下安装您本地签出的代码及其依赖项，以及所有开发依赖项到一个虚拟环境中

pipenv sync --dev

2. 创建一个环境文件并填写所需的值

cp .env.sample .env

3. 在虚拟环境中运行脚本，这将自动加载您的.env

pipenv run anchorconnector

为了在开发此库时添加新依赖项

pipenv install --dev $package

为了添加此库正确运行所需的新依赖项，请将包添加到./setup.py中的install_requires部分，然后

pipenv install

发布包

python setup.py sdist bdist_wheel
twine upload dist/*

或

make publish