Skip to content

Commit cbddd1d

Browse files
committed
improve the python api docs
1 parent 52a16ea commit cbddd1d

File tree

4 files changed

+23
-7
lines changed

4 files changed

+23
-7
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
Please contact support at [[email protected]](mailto:[email protected]) if you would like to manage an
2+
organization. Tell us what you're doing, and select an organization name, title,
3+
description, email address, and url. We will then create your organization and
4+
make your account an admin of the organization. You will then be able to create
5+
new users in your org and generate a temporary authentication link for any user.
6+
17
::: cocalc_api.hub.Organizations
Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
# CoCalc Python API Client
22

3-
4-
Install the Python client API `cocalc-api` that is [hosted on Pypi](
5-
https://pypi.org/project/cocalc-api/).
6-
3+
Install the Python client API `cocalc-api` that is [hosted on Pypi](https://pypi.org/project/cocalc-api/).
74

85
```sh
96
pip install cocalc-api
107
```
118

12-
Obtain a [CoCalc account API Key](https://doc.cocalc.com/apikeys.html), then start using CoCalc from your Python scripts.
9+
Obtain a [CoCalc account API Key](https://doc.cocalc.com/apikeys.html) by going to [your account preferences](https://cocalc.com/settings/account) and scrolling down to "Api Keys", then start using CoCalc from your Python scripts. This API is mostly for account level API keys, but it also provides some minimal support for project specific API keys.
10+
11+
Using an account level API key, the cocalc_api Python library enabled you to do all of the following very easily from a Python script:
12+
13+
- [search](api/system/) for other cocalc users by name or email address, and get the name associated to an account_id
14+
- list [your projects](api/projects), add and remove collaborators, copy files between projects and start, stop and create projects.
15+
- use the [Jupyter API](api/jupyter) to evaluate code using a kernel, either in an anonymous sandbox or in one of your projects.
16+
- read or write any data you have access to in the CoCalc [PostgreSQL database](api/database), as defined by [this schema](https://github.com/sagemathinc/cocalc/tree/master/src/packages/util/db-schema).
17+
- instantly send and receive [messages](api/messages) with any other cocalc users
18+
- create and manage users in an [organization](api/organizations), including automatically generating authentication links, so you're users do not have explicitly create a CoCalc account. You can see when they are active and send them messages.
19+
20+
Currently a project specific API key can be used to:
21+
22+
- Run [shell commands](api/project) and Jupyter code in a specific project.

src/python/cocalc-api/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "cocalc-api"
3-
version = "0.3.0"
3+
version = "0.4.0"
44
description = "Python client for the CoCalc API"
55
authors = [{ name="William Stein", email="[email protected]" }]
66
readme = "README.md"

src/python/cocalc-api/uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)