支持在认知尺度的皮层认知平台中程序化地创建资源
cortex-python-builders的Python项目详细描述
皮层资源的程序化构建
cortex python builders模块提供了使用python以编程方式构建cortex资源(例如技能、操作、数据集等)的工具。 有关如何使用库的详细信息,请参阅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-builders
或源代码:
> git clone git@github.com:CognitiveScale/cortex-python-builders.git
> cd cortex-python-builders
> pip install -e .
开发
设置
开发时,最好在虚拟环境中工作。创建并激活虚拟环境:
> virtualenv --python=python3.6 _venv
> source _venv/bin/activate
安装开发人员依赖项:
> git clone git@github.com:CognitiveScale/cortex-python-builders.git
> cd cortex-python-builders
> make dev.install
这里有一个方便的Makefile
命令,可以执行常见任务,如构建、测试等。使用它!
测试
单元测试
遵循以上设置说明(确保处于虚拟环境中并具有必要的依赖关系)
make test
运行测试套件
要运行单个文件或类方法,请使用pytest。下面显示的测试示例:
- 文件:
pytest test/unit/ames_test.py
- 类方法:
pytest test/unit/ames_test.py::TestLocal::test_analysis
发布alpha版本
假设您想发布新的功能,这样就可以在不发布新的官方版本的情况下安装它。我们需要在pypi中使用alpha版本。
- 我们需要创建并发布alpha版本:
- 获取
cortex-python-builders
PYPI CognitiveScale帐户的凭据(通过LastPass) - 运行
make dev.push TAG=<alpha release number>
。示例:make dev.push TAG=1
贡献
在向库中投稿后,在以PR形式提交更改之前,请执行以下操作
- 通过
make test
运行单元测试
- 手动验证(即尝试皮质的新变化)以确保一切顺利。不是必需的,但是非常鼓励。
- 提高
setup.py
版本并更新CHANGELOG.md
文件
包文档是用sphinx构建的。构建文档:
> make docs
文档将以html格式呈现在docs/_build/html
目录下。
激活您的虚拟环境:
> source _venv/bin/activate
如果尚未设置环境,请执行以下操作:
> make dev.install
预释放至分期
- 创建并推动alpha版本:
其中> make dev.push TAG=1
TAG
是alpha版本号。这将构建一个alpha标记的包。 - 合并
develop
到staging
分支:> make stage
- 在github中,创建从
staging
到master
的拉取请求。