V1.10.3 Update README.md

Author: Evil0ctal

README.md

@@ -3,40 +3,148 @@
 <a href="https://github.com/TikHubIO/TikHub-API-Python-SDK/blob/main/README.en.md">English</a> | <a href="https://github.com/TikHubIO/TikHub-API-Python-SDK/blob/main/README.md">简体中文</a>
 </div>
 
-#### 简介
+#### **简介**
 
-[TikHub](https://tikhub.io/)是一个All in one的RESTful API平台。
+🎉「[TikHub.io](https://tikhub.io/)」是一个**开箱即用的集成工具以及服务的平台**，我们的目标是帮助用户快速开展业务，并且支持功能定制。我们的愿景是组建一个社区创业项目，独木难成林，合作能共赢，**每一个社区成员都有机会将他们编写的功能或接口接入我们的平台，并且从中获得收益**。我们已经积累了大量的注册用户以及社区用户，并且为了实现这一愿景，我们正在积极筹划和落实合作策略，以确保生态的持续健康发展，欢迎各位加入我们的[Discord](https://discord.gg/aMEAS8Xsvz)社区。
 
-我们提供的API只能获取公开数据，即任何人都可以通过浏览器及APP等访问抖音,TikTok,小红书以获取它们。
+---
 
-如果您有任何建议或者需求，请联系我们，更多的功能正在开发中，敬请期待！
+#### **快速开始**
 
----
+[TikHub.io](https://tikhub.io/)的大多数API都是RESTFUL的，这意味着你只需要使用基本的HTTP请求即可完成调用。
+
+所有的API都是基于OPenAPI规范进行编写的，这意味着你可以使用我们的`openapi.json`自动生成任何形式的API文档：
 
-#### 鉴权
+[https://api.tikhub.io/openapi.json](https://api.tikhub.io/openapi.json)
 
-接口文档中带有🔒的接口需要在请求头中携带Token才可调用。
+当然，我们已经默认使用了Swagger UI来展示我们的API文档，你可以在网页上打开下面的链接，然后在网页上进行API Token的认证，随后点击任意端点然后点击`Try it out`即可测试你所需要的端点，大多数端点都已经携带了默认值或演示值，这会更好的帮助你理解调用的所需参数：
 
-调用这些接口会使用你账户中的剩余请求次数！
+[https://api.tikhub.io](https://api.tikhub.io)
 
 ---
 
-#### 购买
+#### **鉴权**
+
+> 简介
+
+接口文档中带有🔒图标的端点需要在请求头中携带API Token才可以调用，调用这些接口会使用你账户中的剩余免费额度或账户余额，同时每一个端点还会根据API Token所有者的email地址进行请求速率的限制，每个端点之间都有彼此独立的RPS（Requests per second），在大多数情况下，用户可以每秒请求5次同一个端点。
+
+> 生成API Token
+
+获取API Token的步骤也很简单，你只需要登录到我们的用户后台 [TikHub User](https://tikhub.io/users/api_keys)，然后点击左侧的`API Keys`就可以生成你自己的API Token，同时，你可以自定义API Token的权限（`Scopes`），也可以设置API Token的过期日期（`Expire Date`），还可以手动暂时关闭API Token（`Status`）。
+
+> 在API文档网页上使用
+
+当你完成上面的步骤后，你可以复制你的API Token，然后回到我们的Swagger UI网页，点击页面右侧的绿色`Authorize`，然后在弹窗底部的`Value`输入框中粘贴API Token即可完成鉴权。
 
-Website(🚧ing): [tikhub.io](https://tikhub.io/)
+> 在HTTP请求中使用
 
-API Document: [api.tikhub.io](https://api.tikhub.io/)
+如果你想在HTTP请求中携带API Token，请仔细阅读下方的格式，并且需要在请求头中携带一个叫`Authorization`的字段，下面我将给出一个JSON作为header的示范：
 
-Discord(Support): [https://discord.gg/kk23BGeYrJ](https://discord.gg/kk23BGeYrJ)
+{
 
-Github: [https://github.com/TikHubIO](https://github.com/TikHubIO)
+"Authorization":"Bearer Your_API_Token"
 
-Email: [tikhub.io@proton.me](mailto:tikhub.io@proton.me)
+}
+
+> 备注
+
+请不要分享你的API Token，这可能会造成你的财产损失等一些列问题，我们强烈建议为你的每一个项目都使用不同的API Token，同时不要忘记在创建API Token时勾选对应的`Scopes`，否则在请求时会遇到权限不足的问题。
 
 ---
 
-#### 公告
+## **使用SDK**
+
+- 通过PyPi安装我们的[SDK](https://pypi.org/project/tikhub/)
+
+```console
+pip install tikhub
+```
+
+- 导入SDK
+
+```python
+from tikhub import Client
+```
+
+- 初始化Client
+
+```python
+client = Client(base_url="https://api.tikhub.io", 
+                    api_key="YOUR_API_TOKEN",
+                    proxies=None,
+                    max_retries=3,
+                    max_connections=50,
+                    timeout=10,
+                    max_tasks=50)
+```
+
+- 请求用户数据示例
+
+```python
+# 请求用户信息 | Request user info
+user_info = await client.TikHubUser.get_user_info()
+print(user_info)
+
+# 请求用户每日使用情况 | Request user daily usage
+user_daily_usage = await client.TikHubUser.get_user_daily_usage()
+print(user_daily_usage)
+
+# 计算价格 | Calculate price
+price = await client.TikHubUser.calculate_price(endpoint="/api/v1/douyin/app/v1/fetch_one_video", request_per_day=100)
+print(price)
+
+# 获取阶梯式折扣百分比信息 | Get tiered discount percentage information
+tiered_discount_info = await client.TikHubUser.get_tiered_discount_info()
+print(tiered_discount_info)
+
+# 获取一个端点的信息 | Get information of an endpoint
+endpoint_info = await client.TikHubUser.get_endpoint_info(endpoint="/api/v1/douyin/app/v1/fetch_one_video")
+print(endpoint_info)
+
+# 获取所有端点信息 | Get all endpoints information
+all_endpoints_info = await client.TikHubUser.get_all_endpoints_info()
+print(all_endpoints_info)
+```
+
+- Client中的可用属性
+
+```python
+# TikHub
+self.TikHubUser = TikHubUser(self.client)
+
+# Douyin
+self.DouyinWeb = DouyinWeb(self.client)
+self.DouyinAppV1 = DouyinAppV1(self.client)
+self.DouyinAppV2 = DouyinAppV2(self.client)
+self.DouyinAppV3 = DouyinAppV3(self.client)
+
+# TikTok
+self.TikTokWeb = TikTokWeb(self.client)
+self.TikTokAppV2 = TikTokAppV2(self.client)
+self.TikTokAppV3 = TikTokAppV3(self.client)
+
+# Instagram
+self.InstagramWeb = InstagramWeb(self.client)
+
+# Weibo
+self.WeiboWeb = WeiboWeb(self.client)
+```
+
+- 使用`DouyinAppV1`的`fetch_one_video`方法调用接口获取单一视频数据。
+
+```python
+# 获取单个作品数据 | Get single video data
+video_data = await client.DouyinAppV1.fetch_one_video(aweme_id="7345492945006595379")
+print(video_data)
+```
+
+- 我们已经使用HTTPX的对大多数端点进行了异步封装，如果你的代码是同步执行的，你可以使用下面的代码防止异步传染。
 
-TikHub的API将使用**免费加付费**的形式运行。
+```python
+# 使用asyncio.run防止异步传染到其他代码 | Use asyncio.run to prevent asynchronous infection to other code
+video_data = asyncio.run(client.DouyinAppV1.fetch_one_video(aweme_id="7345492945006595379"))
+print(video_data)
+```
 
-登录后，通过签到可以随机获得50-100次API请求，每24小时可签到一次。
+- 由于章节有限，在此处就不列出完整的方法了，你可以通过查看源代码的形式查看每一个属性内实现的方法，并且每个方法接受的参数都已经加上了`type hints`。

dist/tikhub-1.10.3-py3-none-any.whl

@@ -13,7 +13,7 @@
 
 setup(
     name="tikhub",
-    version="1.10.2",
+    version="1.10.3",
     author="TikHub.io",
     author_email="tikhub.io@proton.me",
     description="A Python SDK for TikHub RESTful API",