Skip to content

Commit 1c9c13a

Browse files
authored
Merge pull request #15 from cto-ai/repo-updates
add readme updates and workflows updates
2 parents 32def73 + 65e6025 commit 1c9c13a

File tree

2 files changed

+51
-13
lines changed

2 files changed

+51
-13
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2020 Hack Capital Ventures, Inc.
1+
Copyright (c) 2022 Hack Capital Ventures, Inc.
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,59 @@
11
![](https://cto.ai/static/sdk-banner.png)
22

3-
# sdk-python
43

5-
This is the Python version of The Ops Platform SDK. In
6-
conjunction with our Docker base images, it allows the development of
7-
automations with rich user interfaces, that run in both the local
8-
terminal and in Slack. Other than the Ops Platform itself, this SDK
9-
depends on:
4+
# CTO.ai-py
5+
6+
CTO.ai API Python bindings.
7+
8+
9+
## Table of Contents
10+
11+
- [CTO.ai-py](#ctoai-py)
12+
- [Table of Contents](#table-of-contents)
13+
- [Introduction](#introduction)
14+
- [Install from source](#install-from-source)
15+
- [SDK-Python](#sdk-python)
16+
- [The Workflows Platform](#the-workflows-platform)
17+
- [Documentation](#documentation)
18+
- [License](#license)
19+
20+
21+
## Introduction
22+
23+
CTO.ai-py is a Python library that handles client connections and wraps API functions for interacting with the CTO.ai API.
24+
25+
26+
## Install from source
27+
28+
```bash
29+
git clone https://github.com/cto-ai/sdk-python.git
30+
cd ctoo_ai
31+
```
32+
33+
34+
## SDK-Python
35+
36+
This is the Python version of the Workflows Platform SDK. In
37+
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:
1038

1139
- Python 3.6+
1240
- The `requests` library, version 2+
1341

14-
## The Ops Platform
42+
## The Workflows Platform
43+
44+
This SDK is designed to work in conjunction with the Workflows Platform. Please see the [Platform page](https://cto.ai/platform) for more details.
45+
46+
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)
47+
48+
## Documentation
49+
50+
You can find the Workflow and CTO.ai Py documentation on the [docs website](https://cto.ai/docs/python-sdk-overview).
51+
52+
53+
## License
54+
55+
© Hack Capital Ventures, Inc.
1556

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

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

0 commit comments

Comments
 (0)