Support for programmatic creation of resources in the CognitiveScale Cortex Cognitive Platform
Programmatic Building of Cortex Resources
The Cortex Python Builders module provides tools to programmatically build Cortex resources (e.g. Skill, Actions, Datasets, etc.) using Python. Refer to the Cortex documentation for details on how to use the library:
- Developer guide: https://docs.cortex.insights.ai/docs/developer-guide/overview/
- Cortex Python references: https://docs.cortex.insights.ai/docs/developer-guide/reference-guides
> pip install cortex-python-builders
or from source code:
> git clone email@example.com:CognitiveScale/cortex-python-builders.git > cd cortex-python-builders > pip install -e .
When developing, it's a best practice to work in a virtual environment. Create and activate a virtual environment:
> virtualenv --python=python3.6 _venv > source _venv/bin/activate
Install developer dependencies:
> git clone firstname.lastname@example.org:CognitiveScale/cortex-python-builders.git > cd cortex-python-builders > make dev.install
There's a convenience
Makefile that has commands to common tasks, such as build, test, etc. Use it!
Follow above setup instructions (making sure to be in the virtual environment and having the necessary dependencies)
make testto run test suite
To run an individual file or class method, use pytest. Example tests shown below:
- class method:
Publishing an alpha build
Suppose you want to release new functionality so it can be installed without releasing a new official version. We need to use an alpha version in PyPi.
- we need to create and publish an alpha release:
- get credentials to the
cortex-python-builderspypi CognitiveScale account (via lastpass)
make dev.push TAG=<alpha release number>. Example:
make dev.push TAG=1
After contributing to the library, and before you submit changes as a PR, please do the following
- Run unit tests via
- Manually verification (i.e. try the new changes out in Cortex) to make sure everything is going well. Not required, but highly encouraged.
- Bump up
setup.pyversion and update the
The package documentation is built with Sphinx. To build the documentation:
> make docs
The documentation will be rendered in HTML format under the
Activate your virtual environment:
> source _venv/bin/activate
Setup your environment, if you have not done so:
> make dev.install
Pre-release to staging
- Create and push an alpha release:
> make dev.push TAG=1
TAGis the alpha version number. This will build an alpha-tagged package.
> make stage
- In GitHub, create a pull request from
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|cortex_python_builders-1.0.0-py3-none-any.whl (47.5 kB) Copy SHA256 hash SHA256||Wheel||py3|
|cortex-python-builders-1.0.0.tar.gz (31.2 kB) Copy SHA256 hash SHA256||Source||None|