Metadata-Version: 2.4
Name: apizero
Version: 0.1.1
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Rust
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: requests>=2.28 ; extra == 'compat'
Provides-Extra: compat
Summary: 极数本源官方 Python SDK。Rust 核心，一把 Key 调全站接口。
Keywords: apizero,api,video-parse
Author-email: ApiZero <api@zerois.cn>
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Documentation, https://apizero.cn/aidocs
Project-URL: Homepage, https://apizero.cn
Project-URL: Marketplace, https://apizero.cn/marketplace

# apizero

[极数本源](https://apizero.cn) 官方 Python SDK。一把 Key 调用商城全部接口，GET / POST 写法相同。

底层是 **Rust** 同步实现。返回值已经是对象，直接 `r.title`、`r.video_url`，不用再 JSON 序列化或反序列化。

## 安装

```bash
pip install apizero
```

```python
import apizero

vd = apizero.key("sk_live_xxx")
```

不传 Key 时读取环境变量 `APIZERO_KEY`。申请 Key：https://apizero.cn/account/keys

## 参数从哪里来

每个接口的方法名、必填 / 可空字段、含义和示例，都来自线上页面，并带进 IDE 提示：

- 接口文档：https://apizero.cn/aidocs
- 接口商城：https://apizero.cn/marketplace

例如 [video-parse](https://apizero.cn/aidocs/video-parse) 页上的 `url`（必填）、`flat`（可空），就是代码里的同名参数。

## 两种写法

**写法一：一次传入**（关键字或字典）

```python
r = vd.video_parse(url="https://v.douyin.com/xxxx", flat=1)
# 或
r = vd.video_parse({"url": "https://v.douyin.com/xxxx", "flat": 1})
print(r.ok, r.title, r.video_url)
```

**写法二：先赋值再取值**

```python
vd.video_parse.url = "https://v.douyin.com/xxxx"
vd.video_parse.flat = 1
print(vd.video_parse.ok, vd.video_parse.title, vd.video_parse.video_url)
```

两种写法等价。`r.ok` 为 `True` 表示网关 `code == 0`。失败看 `r.msg`、`r.request_id`。

其它接口同样：

```python
r = vd.weather(city="北京")
r = vd.movie_box()
r = vd.api("video-parse", url="https://v.douyin.com/xxxx", flat=1)
```

Python 关键字如 `from` 写成 `from_`。

## 返回值

```python
r.ok           # 是否成功
r.code
r.msg
r.request_id
r.title        # data 里的字段会提升到顶层
r.video_url
r.data         # 也可以 r.data.title
r.json         # 完整原始字典
```

## 维护

由 **极数本源（ApiZero）** 维护。

- 官网 https://apizero.cn
- 文档 https://apizero.cn/aidocs
- 商城 https://apizero.cn/marketplace
- 邮箱 api@zerois.cn

