Metadata-Version: 2.1
Name: cortex-python
Version: 6.5.0a2
Summary: Python module for the Tecnotree Sensa Platform
License: Apache-2.0
Author: Tecnotree
Author-email: support@tecnotree.com
Requires-Python: >=3.9,<3.12
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: models-dev
Provides-Extra: models-runtime
Requires-Dist: cuid (>=0.4,<1)
Requires-Dist: dill (>=0.3.6)
Requires-Dist: ipython (>=8.10,<9) ; extra == "models-dev"
Requires-Dist: jinja2 (<4) ; extra == "models-dev"
Requires-Dist: matplotlib (>3,<4) ; extra == "models-dev"
Requires-Dist: mlflow (>1) ; extra == "models-dev" or extra == "models-runtime"
Requires-Dist: pandas (<3) ; extra == "models-dev"
Requires-Dist: pyjwt[crypto] (<3)
Requires-Dist: python-dateutil (>=2.8.2,<3)
Requires-Dist: pytimeparse2 (>=1.7.1,<2.0.0)
Requires-Dist: pyyaml (>=5.4.1)
Requires-Dist: requests (>=2.31.0,<3)
Requires-Dist: requests-toolbelt (>=1.0.0)
Requires-Dist: seaborn (>0.13,<0.14) ; extra == "models-dev"
Description-Content-Type: text/markdown

# 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://cognitivescale.github.io/cortex-fabric/
- Cortex Python references: https://cognitivescale.github.io/cortex-python/master/

## Installation

To install: 

```bash
pip install cortex-python
```

or from source code:

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

To install the optional components: 

When developing models using jupyter within notebooks

```bash
poetry install cortex-python[models_dev]
```

When using model SDK using jupyter within notebooks

```bash
poetry install cortex-python[models_dev]
```

When 

```bash
poetry install cortex-python[models_dev]
```

## Development 

### Setup

When developing, it's a best practice to work in a virtual environment. Create and activate a virtual environment:

```bash
poetry install
poetry shell
```

Install developer dependencies:

```bash
git clone git@github.com:CognitiveScale/cortex-python.git
cd cortex-python
make dev.install
```

Run Developer test and linting tasks:
Three types of checks are configured for this:
1. [symilar](https://pylint.readthedocs.io/en/v2.16.2/symilar.html) - to test code duplication
2. [pylint](https://pylint.readthedocs.io/en/v2.16.2/) - for linting
3. [pytest](https://docs.pytest.org/en/7.2.x/) - for running the unit tests. These are orchestrated through [tox](https://tox.wiki/en/3.27.1/). The tox configuration is available at [`tox.ini`](/tox.ini)

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`. The alpha pre-release number (the N in X.Y.ZaN) with be determined automatically.

### 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

Activate your virtual environment:

```bash
poetry shell
```

Set up your environment, if you have not done so:

```bash
make dev.install 
```

The package documentation is built with Sphinx and generates versioned documentation for all tag matching the `release/X.Y.Z` pattern and for the `master` branch. To build the documentation:

```bash
make docs.multi
```
The documentation will be rendered in HTML format under the `docs/_build/${VERSION}` directory.

### Pre-release to staging

1. Create and push an alpha release:

```bash
make dev.push
```
    This will build an alpha-tagged package.
2. Merge `develop` to `staging` branch:

```bash
make stage
```

3. In GitHub, create a pull request from `staging` to `master`.


## TODO
- [x] extending the client with helpers for cortex resources 
- [x] camelcase in pylinyrc
- [ ] Update all documentation with proper Sphinx formatting
  - [x] Most of the major modules have been fixed except skill.py, model.py
- [x] use exceptions defined in `cortex/exceptions.py`
- [ ] integrate the cortex-python-profiles package back into the python SDK
