TVDBAPIv3的简单客户端。
client-for-tvdb的Python项目详细描述
tvdb客户端
用于Tvdb API v3的简单客户端。在
入门
这些说明将使您在 用于开发和测试的本地机器。有关说明，请参见部署 如何在活动系统上部署项目。在
先决条件
Tvdb账户
您将需要来自TVDb.com网站客户端访问。获得 键，请执行以下步骤：
- 在
- Register获取并验证帐户。在
- 在
- Log into你的帐户。在
- 在
- Fill your details生成新的API密钥。在
Python安装（建议使用虚拟环境）
您还需要启动并运行python>；=3.6。如果您的操作系统没有
适当的python版本，您可以安装pyenv
并使用适当的python版本创建一个虚拟环境。你也会的
需要最新的pip安装（版本20.0.2或更高版本是我们的
建议）。所以一旦你安装了pyenv
（见pyenv install instructions），
为项目创建一个虚拟环境（我们将使用python版本3.8）：
pyenv virtualenv 3.8.1 client-for-tvdb
在我们最近创建的python环境中输入（client-for-tvdb）：
升级pip包：
pip install --upgrade pip
安装poetry包：
pip install poetry
安装
安装必备组件后，可以继续安装
项目。项目使用pyproject.toml文件来管理安装
（PEP517）并且我们还将使用python包
poetry作为我们的build-system
（PEP518）。因此，要进行安装，只需cd到
文件夹项目：
cd client-for-tvdb
并通过poetry命令运行依赖项的安装：
poetry install
运行API客户端
要初始化客户端API，必须首先使用此客户端API 适当的凭证：
fromclient_for_tvdbimportTvdbClienttvdb_client=TvdbClient(user_name="Your user name",user_key="Your user key",api_key="Your API key")
你也可以通过环境变量来设置你的凭证
在.env文件中，该文件应位于client_for_tvdb内
模块（或者您可以export它们）：
TVDB_USER_NAME=<Your user name>
TVDB_USER_KEY=<Your user key>
TVDB_API_KEY=<Your API key>
您可以执行以下查询，假设您已经设置了
通过.env文件的凭据：
- 在
要获取可能匹配的电视节目列表：
fromclient_for_tvdbimportTvdbClienttvdb_client=TvdbClient()# get a list of dictionaries with tvshows from the TVDB APIsearch_result=tvdb_client.search("Game of Thrones")
在 - 在
要只获得最接近匹配的电视节目：
fromclient_for_tvdbimportTvdbClienttvdb_client=TvdbClient()# will return a dictionarysearch_result=tvdb_client.search_closest_matching("Game of Thrones")
在 - 在
您还可以执行一个提供
tvdb_id的查询fromclient_for_tvdbimportTvdbClienttvdb_client=TvdbClient()# will return a dictionarysearch_result=tvdb_client.get_serie_by_id(121361)
在
运行测试
要运行我们的项目测试，您可以使用pytest进行覆盖：
PYTHONPATH=. pytest tests/ --cov client_for_tvdb/
用
贡献
请阅读CONTRIBUTING.md了解有关我们的代码的详细信息 行为，以及向我们提交拉取请求的过程。在
版本控制
我们使用CalVer进行版本控制。对于可用版本， 参见tags on this repository。在
作者
- Pol Canelles-初始工作-opacam
另请参见contributors列表 谁参与了这个项目。在
许可证
这个项目是在麻省理工学院许可下授权的-有关详细信息，请参阅LICENSE.md文件
致谢
- 项目
标签：
欢迎加入QQ群-->： 979659372
