Skip to content

Commit

Permalink
Merge pull request #41 from noteable-io/update-intro
Browse files Browse the repository at this point in the history
include intro content
  • Loading branch information
rgbkrk authored Oct 12, 2023
2 parents 718ff46 + 0dc2079 commit 4edd508
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,43 @@ sidebar_position: 1
# The Noteable

Let's discover **Noteable in less than 5 minutes**.

## What is Noteable?

Noteable lets you **create, edit, and share** computational notebooks. You can do it as a human or enable LLMs to do it for you, like you see on the Noteable Plugin on ChatGPT.

## Installation

```
pip install noteable-origami
```

## Configuration

1. Log in to [Noteable](https://app.noteable.io) (sign up is free).
2. In the User Settings tab, navigate to `API Tokens` and generate a new token.
3. Set your API Token as environment variable `NOTEABLE_TOKEN`

## Creating your First Notebook

```python
import os
import asyncio
from origami.clients.api import APIClient

async def main():
api_client = APIClient()

user = await api_client.user_info()
project_id = user.origamist_default_project_id

file = await api_client.create_notebook(
project_id=project_id,
path="Origami Demo.ipynb"
)
print(file)

if __name__ == "__main__":
asyncio.run(main())
```

0 comments on commit 4edd508

Please sign in to comment.