JikanPy 项目安装与使用教程

1. 项目的目录结构及介绍

JikanPy 项目的目录结构如下：

jikanpy/
├── jikanpy/
│   ├── __init__.py
│   ├── jikan.py
│   ├── aiojikan.py
│   ├── abstractjikan.py
│   ├── utils.py
│   └── exceptions.py
├── tests/
│   ├── __init__.py
│   ├── test_jikan.py
│   ├── test_aiojikan.py
│   └── test_utils.py
├── setup.py
├── README.md
└── requirements.txt

目录结构介绍

• jikanpy/: 包含项目的主要代码文件。

  • __init__.py: 初始化文件，使 jikanpy 成为一个 Python 包。
  • jikan.py: 同步 Jikan API 的封装类。
  • aiojikan.py: 异步 Jikan API 的封装类。
  • abstractjikan.py: 抽象基类，定义了 Jikan API 的通用接口。
  • utils.py: 工具函数文件。
  • exceptions.py: 自定义异常类文件。

• tests/: 包含项目的测试代码。

  • test_jikan.py: 同步 Jikan API 的测试文件。
  • test_aiojikan.py: 异步 Jikan API 的测试文件。
  • test_utils.py: 工具函数的测试文件。

• setup.py: 项目的安装配置文件。

• README.md: 项目的说明文档。

• requirements.txt: 项目的依赖文件。

2. 项目的启动文件介绍

JikanPy 项目没有传统意义上的“启动文件”，因为它是一个库项目，主要用于提供 API 封装功能。用户在使用时，通常会直接导入 jikanpy 包中的类和函数。

例如，使用同步 Jikan API 封装类：

from jikanpy import Jikan

jikan = Jikan()
mushishi = jikan.anime(457)
print(mushishi)

或者使用异步 Jikan API 封装类：

from jikanpy import AioJikan
import asyncio

async def main():
    aio_jikan = AioJikan()
    mushishi = await aio_jikan.anime(457)
    print(mushishi)
    await aio_jikan.close()

asyncio.run(main())

3. 项目的配置文件介绍

JikanPy 项目没有专门的配置文件，用户在使用时不需要进行额外的配置。所有的配置和参数传递都是通过代码中的方法调用来完成的。

例如，设置请求的超时时间：

from jikanpy import Jikan

jikan = Jikan(timeout=2)
mushishi = jikan.anime(457)
print(mushishi)

在这个例子中，timeout 参数用于设置请求的超时时间。

总结

JikanPy 是一个用于封装 Jikan API 的 Python 库，提供了同步和异步两种方式来访问 MyAnimeList 的数据。项目的目录结构清晰，代码组织合理，用户可以通过简单的导入和方法调用来使用该库。