Cortex认知平台基本Python模块1扩展概要
cortex-python-profiles的Python项目详细描述
Cortex认知平台基本Python模块1扩展概要
[Python皮][https://github.com/CognitiveScale/cortex-python] Cortex Python Profiles模块使用Profile of 1相关功能扩展了Base Python Module of the Cortex Cognitive Platform。在
有关如何使用库的详细信息,请参阅Cortex文档:
- 开发者指南:https://docs.cortex.insights.ai/docs/developer-guide/overview/
- Cortex Python引用:https://docs.cortex.insights.ai/docs/developer-guide/reference-guides
安装
要安装:
> pip install cortex-python-profiles
或源代码:
^{pr2}$发展
设置
开发时,在虚拟环境中工作是一种最佳实践。创建和激活虚拟环境:
> virtualenv --python=python3.6 _venv
> source _venv/bin/activate
安装开发人员依赖项:
> git clone git@github.com:CognitiveScale/cortex-python-profiles.git
> cd cortex-python-profiles
> make dev.install
有一个方便的Makefile
,它有一些命令可以执行常见的任务,比如构建、测试等。使用它!在
测试
单元测试
按照上面的设置说明进行操作(确保在虚拟环境中并且具有必要的依赖关系)
make test
运行测试套件
要运行单个文件或类方法,请使用pytest。示例测试如下:
- 文件:
pytest test/unit/agent_test.py
- 类方法:
pytest test/unit/agent_test.py::TestAgent::test_get_agent
发布alpha构建
假设您想要发布新功能,这样就可以在不发布新的正式版本的情况下安装它。我们需要在PyPi中使用alpha版本。在
- 我们需要创建并发布一个alpha版本:
- 获取
cortex-python
pypi CognitiveScale帐户的凭据(通过lastpass) - 运行
make dev.push TAG=<alpha release number>
。示例:make dev.push TAG=1
贡献
在向库中投稿后,以及在您将更改作为PR提交之前,请执行以下操作
- 通过
make test
运行单元测试 - 手动验证(即尝试大脑皮层的新变化)以确保一切顺利。不需要,但高度鼓励。在
- 升级
setup.py
版本并更新CHANGELOG.md
文档
激活虚拟环境:
> source _venv/bin/activate
如果尚未设置环境,请执行以下操作:
> make dev.install
包文档是用Sphinx构建的,并为匹配release/X.Y.Z
模式的所有标记和master
分支生成版本化文档。要构建文档:
> make docs.multi
{cd13>将以HTML格式呈现在目录中。在
预发布到分段
- 创建并推送alpha版本:
其中> make dev.push TAG=1
TAG
是alpha版本号。这将生成一个alpha标记的包。在 - {cd16>
> make stage
在 - 在GitHub中,创建一个从
staging
到{}的拉请求。在
- 项目
标签: