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

Document ploomber-cloud examples #138

Merged
merged 9 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
19 changes: 14 additions & 5 deletions doc/apps/voila.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# Voilà

```{tip}
If you haven't deployed your first application, check out the [quickstart guide.](../quickstart/app.md)
## Deploy an example
edublancas marked this conversation as resolved.
Show resolved Hide resolved

To download and deploy an example Voila application simply run:

```sh
pip install ploomber-cloud
ploomber-cloud key YOUR-KEY
ploomber-cloud examples voila/chat-with-csv
cd basic-app
ploomber-cloud init
ploomber-cloud deploy --watch
edublancas marked this conversation as resolved.
Show resolved Hide resolved
```

## Deploy your own app

To deploy a application you need two files:

1. A Jupyter notebook file (`.ipynb`)
2. A dependencies file (`requirements.txt`)

## Voilà

Currently, Ploomber Cloud supports `Voilà` for deploying Jupyter notebooks as applications. For information on how to write Voilà applications, [please check the documentation](https://voila.readthedocs.io/en/stable/).
For information on how to write Voilà applications, [please check the documentation](https://voila.readthedocs.io/en/stable/).

Click here to see [some examples.](../examples/voila.md)

Expand Down
27 changes: 27 additions & 0 deletions doc/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,33 @@ Then, execute:
ploomber-cloud deploy
```

## Deploying an example

Ploomber Cloud hosts example applications for many different frameworks. To download and deploy one, run `ploomber-cloud examples`:

```sh
ploomber-cloud examples
```

Follow the prompts to choose a framework and specific example name. You may also specify a directory in which to download the example.

Once the application is downloaded, it's ready to deploy! For example, if you downloaded the `basic-app` example for `Flask` in the current directory:

```sh
ploomber-cloud key YOUR-KEY
cd basic-app
ploomber-cloud init
ploomber-cloud deploy --watch
```

If you already know which example you want, you can download it while avoiding prompts with `ploomber-cloud examples framework/example-name`:

```sh
ploomber-cloud examples flask/basic-app
```

A full list of example applications is available [here](https://github.com/bryannho/doc/tree/main/examples)

## Defining environment variables

If your project uses environment variables, you can define them in an `.env` file.
Expand Down
Loading