# 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.
=======
History
=======
0.1.0 (2022-12-30)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/akramz/jupyter_plz",
"name": "jupyter-plz",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "jupyter_plz",
"author": "Akram Zaytar",
"author_email": "zaytarakram@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fa/e0/f54c7472b41e18967aa18f76d3ed47d66b061c73d357b44ab8c3fdba5c09/jupyter_plz-0.1.5.tar.gz",
"platform": null,
"description": "# Copilot, for your Jupyter Notebook\n\n`%plz` is a Jupyter magic command that generates programs from human-readable descriptions in Jupyter notebooks.\n\nhttps://user-images.githubusercontent.com/11509740/210084133-61f2cb2d-9968-4b01-8a67-85fcb92eb312.mov\n\n\n## Installation\n\nYou can install `plz` in your Python virtual environment by running the following command in your terminal:\n\n```bash\npip install plz\n```\n\n## Usage\n\n`plz` uses [GPT-3](https://beta.openai.com/). To use it, you'll need to:\n\n- Activate billing on your OpenAI [account](https://beta.openai.com/account/billing/overview).\n- Grab an API key from [your dashboard](https://beta.openai.com/).\n- Provide the API key to the `jupyter_plz` package upon request inside your notebook.\n\nOnce you have configured your environment, you can run the `plz` magic command in your notebook. Example:\n\n```bash\n%plz \"create a function that generates a random walk in the form of an array.\"\n```\n\nOr markdown guides:\n\n```bash\n%plz --markdown \"Provide a step-by-step guide on how to identify anomalies in a list of numbers.\"\n```\n\n## Credit\n\nThis tool is inspired by [plz-cli](https://github.com/m1guelpf/plz-cli) (designed for the command line).\n\n## License\n\nThis project is open-sourced under the MIT license. See [the License file](LICENSE) for more information.\n\n\n=======\nHistory\n=======\n\n0.1.0 (2022-12-30)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A ChatGPT front-end for Jupyter notebooks (Copilot for Jupyter notebooks).",
"version": "0.1.5",
"split_keywords": [
"jupyter_plz"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a37108ce035943fda2ef4180847a69af37f0164633abb075c399cf27f6dc3d0",
"md5": "2f02629664bd14216ea22a873319e738",
"sha256": "2100ca41972f17a8ec5fcde9ad3eedc7edc36ef2210f673bcee072a77c6fbabc"
},
"downloads": -1,
"filename": "jupyter_plz-0.1.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f02629664bd14216ea22a873319e738",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 5408,
"upload_time": "2023-02-06T08:40:43",
"upload_time_iso_8601": "2023-02-06T08:40:43.369878Z",
"url": "https://files.pythonhosted.org/packages/9a/37/108ce035943fda2ef4180847a69af37f0164633abb075c399cf27f6dc3d0/jupyter_plz-0.1.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fae0f54c7472b41e18967aa18f76d3ed47d66b061c73d357b44ab8c3fdba5c09",
"md5": "3b8e026415745a290a06a57b1939781c",
"sha256": "a22c57d6f8f43b8dabb66bd47e2849e60ae024718fb953703e09dd85a93d12eb"
},
"downloads": -1,
"filename": "jupyter_plz-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "3b8e026415745a290a06a57b1939781c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11305,
"upload_time": "2023-02-06T08:40:45",
"upload_time_iso_8601": "2023-02-06T08:40:45.954608Z",
"url": "https://files.pythonhosted.org/packages/fa/e0/f54c7472b41e18967aa18f76d3ed47d66b061c73d357b44ab8c3fdba5c09/jupyter_plz-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 08:40:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "akramz",
"github_project": "jupyter_plz",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "jupyter-plz"
}
JSON
