Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akramz/jupyter_plz
Copilot for Jupyter notebooks.
https://github.com/akramz/jupyter_plz
chat-gpt chat-gpt-3 chatgpt code-completion copilot jupyter jupyter-notebook jupyter-notebooks
Last synced: 3 months ago
JSON representation
Copilot for Jupyter notebooks.
- Host: GitHub
- URL: https://github.com/akramz/jupyter_plz
- Owner: Akramz
- License: mit
- Created: 2022-12-30T14:40:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T16:51:05.000Z (almost 2 years ago)
- Last Synced: 2024-10-08T18:06:10.853Z (4 months ago)
- Topics: chat-gpt, chat-gpt-3, chatgpt, code-completion, copilot, jupyter, jupyter-notebook, jupyter-notebooks
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 29
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# Copilot, for your Jupyter Notebook
`%plz` is a Jupyter magic command that generates programs from human-readable descriptions in Jupyter notebooks.
https://user-images.githubusercontent.com/11509740/210084133-61f2cb2d-9968-4b01-8a67-85fcb92eb312.mov
## Installation
You can install `plz` in your Python virtual environment by running the following command in your terminal:
```bash
pip install plz
```
## Usage
`plz` uses [GPT-3](https://beta.openai.com/). To use it, you'll need to:
- Activate billing on your OpenAI [account](https://beta.openai.com/account/billing/overview).
- Grab an API key from [your dashboard](https://beta.openai.com/).
- Provide the API key to the `jupyter_plz` package upon request inside your notebook.
Once you have configured your environment, you can run the `plz` magic command in your notebook. Example:
```bash
%plz "create a function that generates a random walk in the form of an array."
```
Or markdown guides:
```bash
%plz --markdown "Provide a step-by-step guide on how to identify anomalies in a list of numbers."
```
## Credit
This tool is inspired by [plz-cli](https://github.com/m1guelpf/plz-cli) (designed for the command line).
## License
This project is open-sourced under the MIT license. See [the License file](LICENSE) for more information.