Skip to content

add readme updates and workflows updates #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 9, 2022
Merged

add readme updates and workflows updates #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2020 Hack Capital Ventures, Inc.
Copyright (c) 2022 Hack Capital Ventures, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
62 changes: 50 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,59 @@
![](https://cto.ai/static/sdk-banner.png)

# sdk-python

This is the Python version of The Ops Platform SDK. In
conjunction with our Docker base images, it allows the development of
automations with rich user interfaces, that run in both the local
terminal and in Slack. Other than the Ops Platform itself, this SDK
depends on:
# CTO.ai-py

CTO.ai API Python bindings.


## Table of Contents

- [CTO.ai-py](#ctoai-py)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Install from source](#install-from-source)
- [SDK-Python](#sdk-python)
- [The Workflows Platform](#the-workflows-platform)
- [Documentation](#documentation)
- [License](#license)


## Introduction

CTO.ai-py is a Python library that handles client connections and wraps API functions for interacting with the CTO.ai API.


## Install from source

```bash
git clone https://github.com/cto-ai/sdk-python.git
cd ctoo_ai
```


## SDK-Python

This is the Python version of the Workflows Platform SDK. In
conjunction with our Docker base images, it allows the development of automations with rich user interfaces, that run in both the local terminal and in Slack. Other than the Workflows Platform itself, this SDK depends on:

- Python 3.6+
- The `requests` library, version 2+

## The Ops Platform
## The Workflows Platform

This SDK is designed to work in conjunction with the Workflows Platform. Please see the [Platform page](https://cto.ai/platform) for more details.

To build and publish Workflows to the Workflows Platform, you will need to use the Workflows CLI. Find installation instructions and reference documentation at [Workflow CLI](https://cto.ai/docs/install-cli)

## Documentation

You can find the Workflow and CTO.ai Py documentation on the [docs website](https://cto.ai/docs/python-sdk-overview).


## License

© Hack Capital Ventures, Inc.

This SDK is designed to work in conjunction with The Ops
Platform. Please see <https://cto.ai/platform> for more details.
Distributed under MIT License (The MIT License).

To build and publish Ops to The Ops Platform, you will need to use
The Ops CLI. Find installation instructions and reference
documentation at <https://cto.ai/docs>.
See [LICENSE](LICENSE) for more information.