معرفی شرکت ها
aiit-sdk-0.0.9
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A python sdk for AIIT OS
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | aiit-sdk-0.0.9 |
| نام | aiit-sdk |
| نسخه کتابخانه | 0.0.9 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Guoqun Jin |
| ایمیل نویسنده | guoqun.jin@hotmail.com |
| آدرس صفحه اصلی | http://192.168.140.202/unstructured-etl-group/aiit-sdk.git |
| آدرس اینترنتی | https://pypi.org/project/aiit-sdk/ |
| مجوز | GNU General Public License v3.0 |
# AIIT-SDK
## 安装
```shell
pip install aiit-sdk
```
如果需要指定安装源，可以使用 -i 参数
```shell
pip install aiit-sdk --index-url https://pypi.org/simple/
```
版本更新，可以使用 --upgrade 参数更新
```shell
pip install --upgrade aiit-sdk --index-url https://pypi.org/simple/
```
## 使用说明
### 登陆模块
在 settings.py 的 `SIMPLE_JWT.AUTH_TOKEN_CLASSES` 参数下面添加 `aiit_sdk.auth.AiitToken`。
配置完成以后，通过大数据OS颁发的 token 就可以正常获取数据，并且后端可以通过 request.user 获取到用户信息。
```python
SIMPLE_JWT = {
'ACCESS_TOKEN_LIFETIME': timedelta(days=1),
'REFRESH_TOKEN_LIFETIME': timedelta(days=7),
'ROTATE_REFRESH_TOKENS': True,
'BLACKLIST_AFTER_ROTATION': True,
'ALGORITHM': 'HS256',
'SIGNING_KEY': JWT_SIGNING_KEY,
'VERIFYING_KEY': None,
'AUTH_HEADER_TYPES': ('Bearer', 'JWT'),
'USER_ID_FIELD': 'id',
'USER_ID_CLAIM': 'user_id',
'AUTH_TOKEN_CLASSES': (
'aiit_sdk.auth.AiitToken', # 允许大数据OS颁发的Token访问
'rest_framework_simplejwt.tokens.AccessToken',
),
'TOKEN_TYPE_CLAIM': 'token_type',
'JTI_CLAIM': 'jti',
'SLIDING_TOKEN_REFRESH_EXP_CLAIM': 'refresh_exp',
'SLIDING_TOKEN_LIFETIME': timedelta(days=7),
'SLIDING_TOKEN_REFRESH_LIFETIME': timedelta(days=30),
}
```
### 接口返回
为了规范数据返回格式，建议通过 APIResponse 进行数据返回。
示例代码：
```python
from aiit_sdk.response import APIResponse
class FileUploadView(APIView):
def post(self, request):
# 业务代码
data = {} # 要返回的数据
return APIResponse(data=data)
```
返回的数据格式：
```json
{
"data": {},
"message": "ok",
"code": 200
}
```
### 分页模块
#### 默认分页模块的配置
将 settings.py 的 `REST_FRAMEWORK.DEFAULT_PAGINATION_CLASS` 参数设置成 `aiit_sdk.page.NormalResultsSetPagination`。
```python
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.BasicAuthentication',
'rest_framework.authentication.SessionAuthentication',
'rest_framework_simplejwt.authentication.JWTAuthentication',
'rest_framework_simplejwt.authentication.JWTTokenUserAuthentication',
),
'DEFAULT_PERMISSION_CLASSES': (
# 'rest_framework.permissions.IsAuthenticated',
),
'DATETIME_FORMAT': '%Y-%m-%d %H:%M:%S',
'DEFAULT_PAGINATION_CLASS': 'aiit_sdk.page.NormalResultsSetPagination', # 默认分页模块的配置
'DEFAULT_FILTER_BACKENDS': (
'django_filters.rest_framework.DjangoFilterBackend',
'rest_framework.filters.OrderingFilter',
'rest_framework.filters.SearchFilter'
),
'PAGE_SIZE': 20,
'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}
```
### 模版视图
位于 `view` 模块下面，有以下几个类：
- AiitListAPIView 列表视图
- AiitCreateAPIView 创建视图
- AiitListCreateAPIView 列表和创建视图
- AiitRetrieveAPIView 详情查看视图
- AiitRetrieveUpdateAPIView 详情查看和更新视图
- AiitRetrieveUpdateDestroyAPIView 详情查看、更新和删除视图
### 算法调用模块
位于 `algo` 模块下面的 `exec_algo()` 函数，通过算法名称调用算法，如果一个算法有多个版本，默认调用最后上传的那个版本。
```python
from aiit_sdk.algo import exec_algo
res = exec_algo(algo_name='cv_name_extra', **params)
```
参数：
- algo_name：算法名称；
- params：调用算法的参数，每个算法有所不同。
### 文件存储
将 settings.py 的 `DEFAULT_FILE_STORAGE` 参数设置成 `aiit_sdk.storage.AiitStorage`。
```python
DEFAULT_FILE_STORAGE = 'aiit_sdk.storage.AiitStorage'
```
### 日志记录模块
位于 `log` 模块下面，有 `create_addition_log()`，`create_change_log()` 和 `create_delete_log()` 3个函数，分别用于记录`添加数据`，`更新数据` 和 `删除数据`的操作。
日志会被记录到 `django.contrib.admin.models` 内的 `LogEntry` 模块内。
نیازمندی
| مقدار | نام |
|---|---|
| >=2.25.1 | requests |
| >=5.1 | django-cacheops |
| >=21.1 | django-filter |
| >=3.12.2 | djangorestframework |
| >=4.6.0 | djangorestframework-simplejwt |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl aiit-sdk-0.0.9:
pip install aiit-sdk-0.0.9.whl
نصب پکیج tar.gz aiit-sdk-0.0.9:
pip install aiit-sdk-0.0.9.tar.gz