PyPI - bk-resource - Versions diffs - 0.4.8__tar.gz → 0.4.10__tar.gz - Mend

bk-resource 0.4.8tar.gz → 0.4.10tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (63) hide show

{bk_resource-0.4.8 → bk_resource-0.4.10}/MANIFEST.in RENAMED Viewed

@@ -1,3 +1,4 @@
+include readme.md
 recursive-include bk_resource/locale *.mo
 recursive-include bk_resource/locale *.po
 recursive-include bk_resource/conf/app_template *.py-tpl

bk_resource-0.4.10/PKG-INFO ADDED Viewed

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: bk_resource
+Version: 0.4.10
+Summary: Bk Resource
+Home-page: https://bk.tencent.com
+Author: blueking
+Author-email: blueking@tencent.com
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: blueapps<5,>=4.10.0
+Requires-Dist: django>=3.2.18
+Requires-Dist: djangorestframework>=3.12.0
+Requires-Dist: drf-yasg>=1.20.0
+Requires-Dist: pyinstrument>=3.4.2
+Requires-Dist: arrow>=1.2.0
+Requires-Dist: django-rest-framework-condition>=0.1.1
+Requires-Dist: celery<5,>=4
+![logo.png](assests/logo.png)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/TencentBlueKing/bk-resource/blob/main/LICENSE.txt)
+[![Release Version](https://img.shields.io/badge/release-0.4.10-brightgreen.svg)](https://github.com/TencentBlueKing/bk-resource/releases)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bk-resource/pulls)
+[![codecov](https://codecov.io/gh/TencentBlueKing/bk-resource/branch/main/graph/badge.svg)](https://codecov.io/gh/TencentBlueKing/bk-resource)
+[![Unittest Py3](https://github.com/TencentBlueKing/bk-resource/actions/workflows/unittest.yml/badge.svg)](https://github.com/TencentBlueKing/bk-resource/actions/workflows/unittest.yml)
+[(English Documents Available)](readme_en.md)
+## Overview
+`bk_resource` 是一个基于 [Blueapps](https://github.com/TencentBlueKing/blueapps) 和 [Django Rest Framework](https://github.com/encode/django-rest-framework) 的脚手架，
+旨在帮助开发人员快速生成符合 [`12-factor`](https://12factor.net/) 规范的 WEB SaaS，并在`DDD`开发实践中方便地创建可扩展的领域服务
+## Features
+- [Basic] 基于 `Django` 进行封装，生成标准 `swagger API`
+- [Basic] 基于 `django-environ` 适配环境变量与 `.env` 配置
+- [Basic] 支持基于 `PEP-621` 的全工具链 (mypy\isort\flake8\black) 配置方案
+- [Basic] 支持代码规范类工具整合：`pre-commit`、`code-cc`
+- [Resource] 集成 `bk_resource` 组织工程目录结构，通过 `Resource` 的方式声明业务逻辑
+- [Resource] 支持 `ApiResource` / `BkApiResource` 调用第三方 `API` 接口
+## Getting started
+### Installation
+1. 安装`cruft`
+```bash
+$ pip install cruft
+```
+2. 通过`cruft`脚本架生成项目
+```bash
+$ cruft create https://github.com/TencentBlueKing/bk-resource.git --checkout main --directory template
+```
+3. 添加远程仓库地址并完成推送
+```bash
+cd {{ project_id }}
+git init
+git add .
+git commit -m "init repo"
+git remote add origin {{ git_url }}
+git push -u origin master
+```
+### 模板生命周期管理
+检查或更新模板前需确保本地代码已提交到 GIT 仓库
+1. 检查模板是否更新
+```bash
+$ cruft check --checkout main
+```
+2. 合并模板到本地项目
+```bash
+$ cruft update --checkout main
+```
+### Usage
+- [快速开始](template/readme.md)
+- [使用文档](docs/usage.md)
+### Domain Driven Design 开发实践
+![ddd](assests/framework.png)
+- Api 交互层
+    通过 UI Api 或者 Open Api 将服务暴露给用户，由对应的 Api 负责对应的业务逻辑串联。
+- Scene 场景层
+    在通过 Api 访问后端时，实际访问的是由 Resource 暴露的一个场景服务，通过场景服务串联领域层的业务逻辑。
+- Domain 领域层
+    领域层聚焦对应的细分模块，负责处理模块的具体业务逻辑，例如，在用户模块中，处理用户注册、登录、修改密码、重置密码等逻辑。
+- Model 模型层
+    在 MVC 框架中 (如 Django)，将代码架构划分为 Model (模型)，View (视图)，Controller (控制器) 三层，View 用于界面展示，在前后端分离开发部署的实践中，已经不再由后端处理，后端只需要处理 Model & Controller。
+## Roadmap
+- [版本日志](release.md)
+## Support
+- [蓝鲸论坛](https://bk.tencent.com/s-mart/community)
+- [蓝鲸 DevOps 在线视频教程](https://bk.tencent.com/s-mart/video/)
+- [蓝鲸社区版交流群](https://jq.qq.com/?_wv=1027&k=5zk8F7G)
+## BlueKing Community
+- [BK-CMDB](https://github.com/Tencent/bk-cmdb)：蓝鲸配置平台（蓝鲸 CMDB）是一个面向资产及应用的企业级配置管理平台。
+- [BK-CI](https://github.com/Tencent/bk-ci)：蓝鲸持续集成平台是一个开源的持续集成和持续交付系统，可以轻松将你的研发流程呈现到你面前。
+- [BK-BCS](https://github.com/Tencent/bk-bcs)：蓝鲸容器管理平台是以容器技术为基础，为微服务业务提供编排管理的基础服务平台。
+- [BK-PaaS](https://github.com/Tencent/bk-paas)：蓝鲸 PaaS 平台是一个开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理 SaaS 应用。
+- [BK-SOPS](https://github.com/Tencent/bk-sops)：标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统，是蓝鲸体系中一款轻量级的调度编排类 SaaS 产品。
+- [BK-JOB](https://github.com/Tencent/bk-job) 蓝鲸作业平台(Job)是一套运维脚本管理系统，具备海量任务并发处理能力。
+## Contributing
+如果你有好的意见或建议，欢迎给我们提 Issues 或 Pull Requests，为蓝鲸开源社区贡献力量。
+[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。
+## License
+基于 MIT 协议， 详细请参考 [LICENSE](LICENSE.txt)

bk_resource-0.4.10/bk_resource.egg-info/PKG-INFO ADDED Viewed

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: bk_resource
+Version: 0.4.10
+Summary: Bk Resource
+Home-page: https://bk.tencent.com
+Author: blueking
+Author-email: blueking@tencent.com
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: blueapps<5,>=4.10.0
+Requires-Dist: django>=3.2.18
+Requires-Dist: djangorestframework>=3.12.0
+Requires-Dist: drf-yasg>=1.20.0
+Requires-Dist: pyinstrument>=3.4.2
+Requires-Dist: arrow>=1.2.0
+Requires-Dist: django-rest-framework-condition>=0.1.1
+Requires-Dist: celery<5,>=4
+![logo.png](assests/logo.png)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/TencentBlueKing/bk-resource/blob/main/LICENSE.txt)
+[![Release Version](https://img.shields.io/badge/release-0.4.10-brightgreen.svg)](https://github.com/TencentBlueKing/bk-resource/releases)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bk-resource/pulls)
+[![codecov](https://codecov.io/gh/TencentBlueKing/bk-resource/branch/main/graph/badge.svg)](https://codecov.io/gh/TencentBlueKing/bk-resource)
+[![Unittest Py3](https://github.com/TencentBlueKing/bk-resource/actions/workflows/unittest.yml/badge.svg)](https://github.com/TencentBlueKing/bk-resource/actions/workflows/unittest.yml)
+[(English Documents Available)](readme_en.md)
+## Overview
+`bk_resource` 是一个基于 [Blueapps](https://github.com/TencentBlueKing/blueapps) 和 [Django Rest Framework](https://github.com/encode/django-rest-framework) 的脚手架，
+旨在帮助开发人员快速生成符合 [`12-factor`](https://12factor.net/) 规范的 WEB SaaS，并在`DDD`开发实践中方便地创建可扩展的领域服务
+## Features
+- [Basic] 基于 `Django` 进行封装，生成标准 `swagger API`
+- [Basic] 基于 `django-environ` 适配环境变量与 `.env` 配置
+- [Basic] 支持基于 `PEP-621` 的全工具链 (mypy\isort\flake8\black) 配置方案
+- [Basic] 支持代码规范类工具整合：`pre-commit`、`code-cc`
+- [Resource] 集成 `bk_resource` 组织工程目录结构，通过 `Resource` 的方式声明业务逻辑
+- [Resource] 支持 `ApiResource` / `BkApiResource` 调用第三方 `API` 接口
+## Getting started
+### Installation
+1. 安装`cruft`
+```bash
+$ pip install cruft
+```
+2. 通过`cruft`脚本架生成项目
+```bash
+$ cruft create https://github.com/TencentBlueKing/bk-resource.git --checkout main --directory template
+```
+3. 添加远程仓库地址并完成推送
+```bash
+cd {{ project_id }}
+git init
+git add .
+git commit -m "init repo"
+git remote add origin {{ git_url }}
+git push -u origin master
+```
+### 模板生命周期管理
+检查或更新模板前需确保本地代码已提交到 GIT 仓库
+1. 检查模板是否更新
+```bash
+$ cruft check --checkout main
+```
+2. 合并模板到本地项目
+```bash
+$ cruft update --checkout main
+```
+### Usage
+- [快速开始](template/readme.md)
+- [使用文档](docs/usage.md)
+### Domain Driven Design 开发实践
+![ddd](assests/framework.png)
+- Api 交互层
+    通过 UI Api 或者 Open Api 将服务暴露给用户，由对应的 Api 负责对应的业务逻辑串联。
+- Scene 场景层
+    在通过 Api 访问后端时，实际访问的是由 Resource 暴露的一个场景服务，通过场景服务串联领域层的业务逻辑。
+- Domain 领域层
+    领域层聚焦对应的细分模块，负责处理模块的具体业务逻辑，例如，在用户模块中，处理用户注册、登录、修改密码、重置密码等逻辑。
+- Model 模型层
+    在 MVC 框架中 (如 Django)，将代码架构划分为 Model (模型)，View (视图)，Controller (控制器) 三层，View 用于界面展示，在前后端分离开发部署的实践中，已经不再由后端处理，后端只需要处理 Model & Controller。
+## Roadmap
+- [版本日志](release.md)
+## Support
+- [蓝鲸论坛](https://bk.tencent.com/s-mart/community)
+- [蓝鲸 DevOps 在线视频教程](https://bk.tencent.com/s-mart/video/)
+- [蓝鲸社区版交流群](https://jq.qq.com/?_wv=1027&k=5zk8F7G)
+## BlueKing Community
+- [BK-CMDB](https://github.com/Tencent/bk-cmdb)：蓝鲸配置平台（蓝鲸 CMDB）是一个面向资产及应用的企业级配置管理平台。
+- [BK-CI](https://github.com/Tencent/bk-ci)：蓝鲸持续集成平台是一个开源的持续集成和持续交付系统，可以轻松将你的研发流程呈现到你面前。
+- [BK-BCS](https://github.com/Tencent/bk-bcs)：蓝鲸容器管理平台是以容器技术为基础，为微服务业务提供编排管理的基础服务平台。
+- [BK-PaaS](https://github.com/Tencent/bk-paas)：蓝鲸 PaaS 平台是一个开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理 SaaS 应用。
+- [BK-SOPS](https://github.com/Tencent/bk-sops)：标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统，是蓝鲸体系中一款轻量级的调度编排类 SaaS 产品。
+- [BK-JOB](https://github.com/Tencent/bk-job) 蓝鲸作业平台(Job)是一套运维脚本管理系统，具备海量任务并发处理能力。
+## Contributing
+如果你有好的意见或建议，欢迎给我们提 Issues 或 Pull Requests，为蓝鲸开源社区贡献力量。
+[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。
+## License
+基于 MIT 协议， 详细请参考 [LICENSE](LICENSE.txt)

{bk_resource-0.4.8 → bk_resource-0.4.10}/bk_resource.egg-info/SOURCES.txt RENAMED Viewed

@@ -1,5 +1,6 @@
 LICENSE.txt
 MANIFEST.in
+readme.md
 setup.py
 bk_resource/__init__.py
 bk_resource/apps.py

{bk_resource-0.4.8 → bk_resource-0.4.10}/bk_resource.egg-info/requires.txt RENAMED Viewed

@@ -1,4 +1,4 @@
-blueapps==4.7.1rc0
+blueapps<5,>=4.10.0
 django>=3.2.18
 djangorestframework>=3.12.0
 drf-yasg>=1.20.0

bk_resource-0.4.10/readme.md ADDED Viewed

@@ -0,0 +1,112 @@
+![logo.png](assests/logo.png)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/TencentBlueKing/bk-resource/blob/main/LICENSE.txt)
+[![Release Version](https://img.shields.io/badge/release-0.4.10-brightgreen.svg)](https://github.com/TencentBlueKing/bk-resource/releases)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bk-resource/pulls)
+[![codecov](https://codecov.io/gh/TencentBlueKing/bk-resource/branch/main/graph/badge.svg)](https://codecov.io/gh/TencentBlueKing/bk-resource)
+[![Unittest Py3](https://github.com/TencentBlueKing/bk-resource/actions/workflows/unittest.yml/badge.svg)](https://github.com/TencentBlueKing/bk-resource/actions/workflows/unittest.yml)
+[(English Documents Available)](readme_en.md)
+## Overview
+`bk_resource` 是一个基于 [Blueapps](https://github.com/TencentBlueKing/blueapps) 和 [Django Rest Framework](https://github.com/encode/django-rest-framework) 的脚手架，
+旨在帮助开发人员快速生成符合 [`12-factor`](https://12factor.net/) 规范的 WEB SaaS，并在`DDD`开发实践中方便地创建可扩展的领域服务
+## Features
+- [Basic] 基于 `Django` 进行封装，生成标准 `swagger API`
+- [Basic] 基于 `django-environ` 适配环境变量与 `.env` 配置
+- [Basic] 支持基于 `PEP-621` 的全工具链 (mypy\isort\flake8\black) 配置方案
+- [Basic] 支持代码规范类工具整合：`pre-commit`、`code-cc`
+- [Resource] 集成 `bk_resource` 组织工程目录结构，通过 `Resource` 的方式声明业务逻辑
+- [Resource] 支持 `ApiResource` / `BkApiResource` 调用第三方 `API` 接口
+## Getting started
+### Installation
+1. 安装`cruft`
+```bash
+$ pip install cruft
+```
+2. 通过`cruft`脚本架生成项目
+```bash
+$ cruft create https://github.com/TencentBlueKing/bk-resource.git --checkout main --directory template
+```
+3. 添加远程仓库地址并完成推送
+```bash
+cd {{ project_id }}
+git init
+git add .
+git commit -m "init repo"
+git remote add origin {{ git_url }}
+git push -u origin master
+```
+### 模板生命周期管理
+检查或更新模板前需确保本地代码已提交到 GIT 仓库
+1. 检查模板是否更新
+```bash
+$ cruft check --checkout main
+```
+2. 合并模板到本地项目
+```bash
+$ cruft update --checkout main
+```
+### Usage
+- [快速开始](template/readme.md)
+- [使用文档](docs/usage.md)
+### Domain Driven Design 开发实践
+![ddd](assests/framework.png)
+- Api 交互层
+    通过 UI Api 或者 Open Api 将服务暴露给用户，由对应的 Api 负责对应的业务逻辑串联。
+- Scene 场景层
+    在通过 Api 访问后端时，实际访问的是由 Resource 暴露的一个场景服务，通过场景服务串联领域层的业务逻辑。
+- Domain 领域层
+    领域层聚焦对应的细分模块，负责处理模块的具体业务逻辑，例如，在用户模块中，处理用户注册、登录、修改密码、重置密码等逻辑。
+- Model 模型层
+    在 MVC 框架中 (如 Django)，将代码架构划分为 Model (模型)，View (视图)，Controller (控制器) 三层，View 用于界面展示，在前后端分离开发部署的实践中，已经不再由后端处理，后端只需要处理 Model & Controller。
+## Roadmap
+- [版本日志](release.md)
+## Support
+- [蓝鲸论坛](https://bk.tencent.com/s-mart/community)
+- [蓝鲸 DevOps 在线视频教程](https://bk.tencent.com/s-mart/video/)
+- [蓝鲸社区版交流群](https://jq.qq.com/?_wv=1027&k=5zk8F7G)
+## BlueKing Community
+- [BK-CMDB](https://github.com/Tencent/bk-cmdb)：蓝鲸配置平台（蓝鲸 CMDB）是一个面向资产及应用的企业级配置管理平台。
+- [BK-CI](https://github.com/Tencent/bk-ci)：蓝鲸持续集成平台是一个开源的持续集成和持续交付系统，可以轻松将你的研发流程呈现到你面前。
+- [BK-BCS](https://github.com/Tencent/bk-bcs)：蓝鲸容器管理平台是以容器技术为基础，为微服务业务提供编排管理的基础服务平台。
+- [BK-PaaS](https://github.com/Tencent/bk-paas)：蓝鲸 PaaS 平台是一个开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理 SaaS 应用。
+- [BK-SOPS](https://github.com/Tencent/bk-sops)：标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统，是蓝鲸体系中一款轻量级的调度编排类 SaaS 产品。
+- [BK-JOB](https://github.com/Tencent/bk-job) 蓝鲸作业平台(Job)是一套运维脚本管理系统，具备海量任务并发处理能力。
+## Contributing
+如果你有好的意见或建议，欢迎给我们提 Issues 或 Pull Requests，为蓝鲸开源社区贡献力量。
+[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。
+## License
+基于 MIT 协议， 详细请参考 [LICENSE](LICENSE.txt)

{bk_resource-0.4.8 → bk_resource-0.4.10}/setup.py RENAMED Viewed

@@ -16,15 +16,20 @@ We undertake not to change the open source license (MIT license) applicable
 to the current version of the project delivered to anyone in the future.
 """
-from setuptools import setup
+from setuptools import setup, find_packages
+with open("readme.md") as f:
+    readme = f.read()
 setup(
     name="bk_resource",
-    version="0.4.8",
+    version="0.4.10",
     author="blueking",
     url="https://bk.tencent.com",
     author_email="blueking@tencent.com",
     description="Bk Resource",
+    long_description=readme,
+    long_description_content_type="text/markdown",
     packages=[
         "bk_resource",
         "bk_resource.conf",
@@ -34,7 +39,7 @@ setup(
         "bk_resource.utils",
     ],
     install_requires=[
-        "blueapps==4.7.1rc0",
+        "blueapps>=4.10.0,<5",
         "django>=3.2.18",
         "djangorestframework>=3.12.0",
         "drf-yasg>=1.20.0",

bk_resource-0.4.8/PKG-INFO DELETED Viewed

@@ -1,13 +0,0 @@
-Metadata-Version: 2.1
-Name: bk_resource
-Version: 0.4.8
-Summary: Bk Resource
-Home-page: https://bk.tencent.com
-Author: blueking
-Author-email: blueking@tencent.com
-License: UNKNOWN
-Platform: UNKNOWN
-License-File: LICENSE.txt
-UNKNOWN

bk_resource-0.4.8/bk_resource.egg-info/PKG-INFO DELETED Viewed

@@ -1,13 +0,0 @@
-Metadata-Version: 2.1
-Name: bk-resource
-Version: 0.4.8
-Summary: Bk Resource
-Home-page: https://bk.tencent.com
-Author: blueking
-Author-email: blueking@tencent.com
-License: UNKNOWN
-Platform: UNKNOWN
-License-File: LICENSE.txt
-UNKNOWN