基于 fastapi 的服务的实用程序。
项目描述
安装
pip install fastapi-serviceutils
用法
有关更多详细信息和用法,请参阅:readthedocs
发展
入门
克隆存储库后,使用以下命令初始化开发环境:
make init
这将创建开发环境 exampleservice/dev。使用以下方式激活它:
poetry shell
笔记:
确保在使用新终端开始处理项目时始终激活环境
poetry shell
注意:在使用make之前也应该激活环境。
更新依赖项
在pyproject.toml中定义的依赖项每次更改后,运行以下命令以确保 environment-definition 和 lock-file 是最新的:
make update
使用 linter 和 checkers 进行检查
要手动运行所有预提交挂钩,请运行:
make check
有关项目状态的信息
要显示有关项目运行的摘要:
make info
文档
该项目的开发人员文档是使用 Sphinx 编写的。
文档源可以在 docs 子目录中找到。
API 文档是从模块、类和函数的文档字符串中自动生成的。我们使用的是 Google 文档字符串标准。
要生成文档,请运行:
make docs
生成的 HTML 文件的输出位于docs/_build目录中。
测试
对于测试,我们使用pytest,有关详细信息,请参阅 Pytest Docs。运行所有测试:
make tests
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。
源分布
fastapi_serviceutils-2.1.0.tar.gz
(28.4 kB
查看哈希)
内置分布
关
fastapi_serviceutils -2.1.0.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | e024b0e3c771fec32e48f07d489bd359b8abbffee3e6f03ad4913ac00869e6c6 |
|
| MD5 | 92fcbe35cd0ac6bb7c96b61028b31a52 |
|
| 布莱克2-256 | cb0e489052c65bb43f2617578d9df97174f13e1501b24d247d0f8279584a72ba |
关
fastapi_serviceutils -2.1.0-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 6058fc39bd93b9081f4858f0377d36608c43c5892b765166acee2fe0ccf15e7a |
|
| MD5 | a2e17cf20bf51849351dc9e5d88ea434 |
|
| 布莱克2-256 | e9f7111805746c9181bc28adc09a0818f4e30067fe8d8325bf7ff96ed34f674b |