Python Module for the Cortex Cognitive Platform

The Cortex Python module provides an API client library to easily integrate with the Cortex Cognitive Platform. 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

Installation

To install:

  > pip install cortex-python

or from source code:

  > git clone git@github.com:CognitiveScale/cortex-python.git
  > cd cortex-python
  > pip install -e .

To install the optional components:

  > pip install cortex-python[viz]
  > pip install cortex-python[jupyter]
  > pip install cortex-python[builders]

Development

Setup

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 git@github.com:CognitiveScale/cortex-python.git
  > cd cortex-python
  > make dev.install

There's a convenience Makefile that has commands to common tasks, such as build, test, etc. Use it!

Testing

Unit Tests

Follow above setup instructions (making sure to be in the virtual environment and having the necessary dependencies)

make test to run test suite

To run an individual file or class method, use pytest. Example tests shown below:

file: pytest test/unit/agent_test.py
class method: pytest test/unit/agent_test.py::TestAgent::test_get_agent

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 pypi CognitiveScale account (via lastpass)
run make dev.push TAG=<alpha release number>. Example: make dev.push TAG=1

Contribution

After contributing to the library, and before you submit changes as a PR, please do the following

Run unit tests via make test
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.py version and update the CHANGELOG.md

Documentation

The package documentation is built with Sphinx. To build the documentation:

> make docs

The documentation will be rendered in HTML format under the docs/_build/html directory.

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
```
Where TAG is the alpha version number. This will build an alpha-tagged package.
Merge develop to staging branch:
```
> make stage
```
In GitHub, create a pull request from staging to master.

Release files for cortex-python 1.0.1a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cortex-python 1.0.1a1
File	Size	Uploaded
cortex-python-1.0.1a1.tar.gz	44.8 kB	Jul 9, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for cortex-python 1.0.1a1
File	Interpreter	ABI	Platform	Reset
cortex_python-1.0.1a1-py3-none-any.whl 70.6 kB Jul 9, 2019	Python 3	none	any	Details

Total release size: 115.3 kB

Release files / cortex-python-1.0.1a1.tar.gz

Download URL	cortex-python-1.0.1a1.tar.gz
Size	44.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`6788fe5ab88d0cc04ff67be84c5e97f26a15d1915076706bedac4e408996d2bd`
BLAKE2b-256 checksum How to use checksums	`85a19cdd5f49125f08ad33ec2ef830dfcbc070efdb83e5b37449b352d8365520`
Upload date	Jul 9, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7`

Release files / cortex_python-1.0.1a1-py3-none-any.whl

Download URL	cortex_python-1.0.1a1-py3-none-any.whl
Size	70.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a4b8370569f74456ec90078237cbda2294c665aee399149985f3cae3e895fd1e`
BLAKE2b-256 checksum How to use checksums	`c9cd0e95c79b03066a1c5027ebab41e93157c93a78bef0ae8f22e8c42bc976d4`
Upload date	Jul 9, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7`