<div align="center">
# zq-django-util
**自强 Studio Django 工具**
<!-- markdownlint-disable-next-line MD036 -->
</div>
<p align="center">
<a href="https://github.com/Nagico/zq-django-util/actions/workflows/code_check.yml">
<img src="https://github.com/Nagico/zq-django-util/actions/workflows/code_check.yml/badge.svg" alt="CI">
</a>
<a href="https://zq-django-util.readthedocs.io/en/latest/?badge=latest">
<img src="https://readthedocs.org/projects/zq-django-util/badge/?version=latest" alt="Documentation Status" />
</a>
<a href="https://codecov.io/gh/Nagico/zq-django-util" >
<img src="https://codecov.io/gh/Nagico/zq-django-util/branch/master/graph/badge.svg" alt="cov"/>
</a>
<a href="https://pypi.org/project/zq-django-util/">
<img src="https://img.shields.io/pypi/v/zq-django-util" alt="pypi">
</a>
</p>
<!-- markdownlint-enable MD033 -->
[English Version](README_EN.md)
## 简介
zq-django-util 是用于辅助搭建 django-drf 应用的工具集合，其中包含：
- 标准异常、响应处理
- jwt、微信认证
- oss 存储与直传
- 默认分页类
- 测试 ViewSet
详细文档：[zq-django-util.readthedocs.io](https://zq-django-util.readthedocs.io/)
## 依赖需求
- Python 3.8+
- Django 3.2+
- Django REST framework 3.12+
**强烈建议**使用官方支持的最新版本，当前的测试环境为：Python 3.10, Django 4.1, DRF 3.14
## 安装
- 安装 zq-django-util 包
使用 `pip` 安装：
```shell
pip install zq-django-util
```
使用 `poetry` 安装：
```shell
poetry add zq-django-util
```
## 使用
可以根据以下说明进行配置，以启用相关功能。
[使用文档](docs/usage)
## 开发
本项目使用 Poetry 进行依赖管理，Pytest 进行单元测试。
[开发文档](docs/development)
Raw data
{
"_id": null,
"home_page": "https://github.com/Nagico/zq-django-util",
"name": "zq-django-util",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "django,drf,util",
"author": "Nagico",
"author_email": "yjr888@vip.qq.com",
"download_url": "https://files.pythonhosted.org/packages/bf/50/372d89815aa4375e30cd86f29414d47e2028ecaf843bd5dabfe2bda456b8/zq_django_util-0.2.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# zq-django-util\n**\u81ea\u5f3a Studio Django \u5de5\u5177**\n\n<!-- markdownlint-disable-next-line MD036 -->\n</div>\n\n<p align=\"center\">\n <a href=\"https://github.com/Nagico/zq-django-util/actions/workflows/code_check.yml\">\n <img src=\"https://github.com/Nagico/zq-django-util/actions/workflows/code_check.yml/badge.svg\" alt=\"CI\">\n </a>\n <a href=\"https://zq-django-util.readthedocs.io/en/latest/?badge=latest\">\n <img src=\"https://readthedocs.org/projects/zq-django-util/badge/?version=latest\" alt=\"Documentation Status\" />\n </a>\n <a href=\"https://codecov.io/gh/Nagico/zq-django-util\" >\n <img src=\"https://codecov.io/gh/Nagico/zq-django-util/branch/master/graph/badge.svg\" alt=\"cov\"/>\n </a>\n <a href=\"https://pypi.org/project/zq-django-util/\">\n <img src=\"https://img.shields.io/pypi/v/zq-django-util\" alt=\"pypi\">\n </a>\n</p>\n<!-- markdownlint-enable MD033 -->\n\n[English Version](README_EN.md)\n\n## \u7b80\u4ecb\n\nzq-django-util \u662f\u7528\u4e8e\u8f85\u52a9\u642d\u5efa django-drf \u5e94\u7528\u7684\u5de5\u5177\u96c6\u5408\uff0c\u5176\u4e2d\u5305\u542b\uff1a\n\n- \u6807\u51c6\u5f02\u5e38\u3001\u54cd\u5e94\u5904\u7406\n- jwt\u3001\u5fae\u4fe1\u8ba4\u8bc1\n- oss \u5b58\u50a8\u4e0e\u76f4\u4f20\n- \u9ed8\u8ba4\u5206\u9875\u7c7b\n- \u6d4b\u8bd5 ViewSet\n\n\u8be6\u7ec6\u6587\u6863\uff1a[zq-django-util.readthedocs.io](https://zq-django-util.readthedocs.io/)\n\n## \u4f9d\u8d56\u9700\u6c42\n\n- Python 3.8+\n- Django 3.2+\n- Django REST framework 3.12+\n\n**\u5f3a\u70c8\u5efa\u8bae**\u4f7f\u7528\u5b98\u65b9\u652f\u6301\u7684\u6700\u65b0\u7248\u672c\uff0c\u5f53\u524d\u7684\u6d4b\u8bd5\u73af\u5883\u4e3a\uff1aPython 3.10, Django 4.1, DRF 3.14\n\n## \u5b89\u88c5\n\n- \u5b89\u88c5 zq-django-util \u5305\n\n\u4f7f\u7528 `pip` \u5b89\u88c5\uff1a\n```shell\npip install zq-django-util\n```\n\n\u4f7f\u7528 `poetry` \u5b89\u88c5\uff1a\n```shell\npoetry add zq-django-util\n```\n\n## \u4f7f\u7528\n\n\u53ef\u4ee5\u6839\u636e\u4ee5\u4e0b\u8bf4\u660e\u8fdb\u884c\u914d\u7f6e\uff0c\u4ee5\u542f\u7528\u76f8\u5173\u529f\u80fd\u3002\n\n[\u4f7f\u7528\u6587\u6863](docs/usage)\n\n## \u5f00\u53d1\n\n\u672c\u9879\u76ee\u4f7f\u7528 Poetry \u8fdb\u884c\u4f9d\u8d56\u7ba1\u7406\uff0cPytest \u8fdb\u884c\u5355\u5143\u6d4b\u8bd5\u3002\n\n[\u5f00\u53d1\u6587\u6863](docs/development)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\u81ea\u5f3aStudio Django \u5de5\u5177",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://zq-django-util.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Nagico/zq-django-util"
},
"split_keywords": [
"django",
"drf",
"util"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cae92450858102efcd693557105672791fd8a742ce55e65915a7a47b772f77b",
"md5": "6bfd7f357156809883a2c39540e56eb9",
"sha256": "863efa7cecb020b92cdb88348706c7b89279ab0efc28a50033bf7cdf08494947"
},
"downloads": -1,
"filename": "zq_django_util-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bfd7f357156809883a2c39540e56eb9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 50461,
"upload_time": "2023-06-09T04:35:52",
"upload_time_iso_8601": "2023-06-09T04:35:52.293671Z",
"url": "https://files.pythonhosted.org/packages/0c/ae/92450858102efcd693557105672791fd8a742ce55e65915a7a47b772f77b/zq_django_util-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf50372d89815aa4375e30cd86f29414d47e2028ecaf843bd5dabfe2bda456b8",
"md5": "4e9ef114b3a4f52ee502c47e0b266599",
"sha256": "2593e4d71143a20d90397747a658b819001d1f3e388694138f34f4aeda6253d5"
},
"downloads": -1,
"filename": "zq_django_util-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "4e9ef114b3a4f52ee502c47e0b266599",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 37237,
"upload_time": "2023-06-09T04:36:00",
"upload_time_iso_8601": "2023-06-09T04:36:00.290111Z",
"url": "https://files.pythonhosted.org/packages/bf/50/372d89815aa4375e30cd86f29414d47e2028ecaf843bd5dabfe2bda456b8/zq_django_util-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-09 04:36:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Nagico",
"github_project": "zq-django-util",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zq-django-util"
}
JSON
