创建rest python微服务的实用程序库
py-ms的Python项目详细描述
python微服务库
python microservice是一个库、最佳实践和推荐的构建方法的集合。 使用python的微服务。
要了解如何使用、安装或构建项目,请参见文档:https://py-ms.readthedocs.io/en/latest/
安装
pip install py-ms
结构
Pyms/config
从字典或路径读取yaml或json配置的模块。
pyms/烧瓶/app
使用函数create_app
初始化烧瓶应用程序,注册blueprints
初始化所有库,如swagger、数据库、跟踪系统、自定义日志格式等。
pyms/烧瓶/健康检查
kubernetes、eureka和其他系统通常使用此视图来检查我们的应用程序是否已启动并正在运行。
Pyms/记录器
以json格式打印日志以发送到服务器,如elasticsearch。在记录器中注入量程记录。
pyms/rest_模板
如果已配置,则在传播跟踪头的业务服务之间封装公共rest操作。
Pyms/示踪剂
创建一个注入器flask_opentracing.FlaskTracer
以在我们的项目中使用
pipenv
优于普通pip和requirements.txt
Pipenv生成两个文件:aPipfile
和aPipfile.lock
。
Pipfile
:是项目依赖关系的高级声明。它可以包含“dev”依赖项(通常是与测试相关的东西)和“standard”依赖项,这是项目运行所需的依赖项Pipfile.lock
:是pipfile安装的所有依赖项的“列表”,以及它们的版本和散列。这可以防止两件事:依赖项之间的冲突和安装恶意模块。
如何…
这里是最常用的pipenv
命令,有关更深入的解释,请参阅official documentation。
安装pipenv
pip install pipenv
安装pip文件中定义的依赖项
pipenv install
安装pip文件中定义的dev和“standard”依赖项
pipenv install --dev
安装新模块
pipenv install django
安装一个新的开发模块(通常是与测试相关的东西)
pipenv install nose --dev
在生产中安装依赖项
pipenv install --deploy
启动外壳
pipenv shell
文件
pipenv install --dev
安装新模块
pipenv install django
安装一个新的开发模块(通常是与测试相关的东西)
pipenv install nose --dev
在生产中安装依赖项
pipenv install --deploy
启动外壳
pipenv shell
文件
pipenv install --deploy
启动外壳
pipenv shell
文件
此项目使用mkdocs
mkdocs new [dir-name]
-创建一个新项目。mkdocs serve
-启动实时重新加载文档服务器。mkdocs build
-建立文档站点。mkdocs help
-打印此帮助消息。
项目布局
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.