Skip to content
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.

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

include intro content #41

Merged
merged 2 commits into from
Oct 12, 2023
Merged
Changes from all commits
Commits
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
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())
```