Skip to main content

Python module for the CognitiveScale Cortex Cognitive Platform

Project description

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:

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

  1. Run unit tests via make test
  2. Manually verification (i.e. try the new changes out in Cortex) to make sure everything is going well. Not required, but highly encouraged.
  3. 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

  1. 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.
  2. Merge develop to staging branch:
    > make stage
    
  3. In GitHub, create a pull request from staging to master.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cortex-python-1.0.1a1.tar.gz (44.8 kB view details)

Uploaded Source

Built Distribution

cortex_python-1.0.1a1-py3-none-any.whl (70.6 kB view details)

Uploaded Python 3

File details

Details for the file cortex-python-1.0.1a1.tar.gz.

File metadata

  • Download URL: cortex-python-1.0.1a1.tar.gz
  • Upload date:
  • Size: 44.8 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for cortex-python-1.0.1a1.tar.gz
Algorithm Hash digest
SHA256 6788fe5ab88d0cc04ff67be84c5e97f26a15d1915076706bedac4e408996d2bd
MD5 8810f077565dacb6b1c6ac196b3a1370
BLAKE2b-256 85a19cdd5f49125f08ad33ec2ef830dfcbc070efdb83e5b37449b352d8365520

See more details on using hashes here.

File details

Details for the file cortex_python-1.0.1a1-py3-none-any.whl.

File metadata

  • Download URL: cortex_python-1.0.1a1-py3-none-any.whl
  • Upload date:
  • Size: 70.6 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for cortex_python-1.0.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 a4b8370569f74456ec90078237cbda2294c665aee399149985f3cae3e895fd1e
MD5 5e8dc3311073113c61134eee513b7e7e
BLAKE2b-256 c9cd0e95c79b03066a1c5027ebab41e93157c93a78bef0ae8f22e8c42bc976d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page