| Name | jupyter-copilot JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | GitHub Copilot for Jupyter |
| upload_time | 2024-09-20 18:50:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c) 2018 jupyter_copilot Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.HE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyter_copilot
[PyPi Package](https://pypi.org/project/jupyter-copilot/)
A GitHub Copilot extension for JupyterLab. This extension uses the language server provided by [copilot.vim](https://github.com/github/copilot.vim) and the [@jupyter/completer](https://jupyterlab.readthedocs.io/en/latest/user/completer.html) module to provide native GitHub Copilot autocomplete into notebooks.
**⚠️ WARNING: You should not use this for remote notebooks over SSH as authentication for the extension server is currently disabled. Also, This extension also only supports JupyterLab and not classic notebooks :(**
**This extension is still very new and may be rough around the edges. If you experience any bugs or have any feature requests please feel free to open an issue or make a PR :)**
## Features
- Inline completions with GitHub Copilot 🤖
- Native GitHub authentication 🔐
- Custom keybindings 🔥
- Multilanguage support
## **Requirements**
- JupyterLab >= 4.0.0
- Node.js >= 18.x
## Setup
To install the extension, execute:
```bash
pip install jupyter_copilot
```
To login to copilot open the command palette with `Ctrl+Shift+C` (`Cmd+Shift+C` on mac) then select the `Sign In With Github` command and follow the instructions.
Once signed in open any notebook and the extension should run!
## Settings
To change settings go to `Settings > Settings Editor` then search for Copilot.
| Setting | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable/Disable | Enables or disables the extension |
| Accept Keybind | The keybind you want to use to accept a completion, default value is `Ctrl + J`. This setting is just a string and is not validated to see if works. Currently using `Tab` for completions does not work, and you must refresh the notebook to see changes in effect. |
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyter_copilot
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# First install jupyterlab with pip
# Clone the repo to your local environment
# Change directory to the jupyter_copilot directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyter_copilot
# Rebuild extension Typescript source after making changes
jlpm build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyter_copilot
pip uninstall jupyter_copilot
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyter_copilot` within that folder.
### Layout and structure
This extension is composed of a Python package named `jupyter_copilot`
for the server extension and a NPM package named `jupyter_copilot`
for the frontend extension.
The extension uses the language server provided by [copilot.vim](https://github.com/github/copilot.vim) for authentication and to actually fetch completions from GitHub. The language server is packaged as a node module caleld [copilot-node-server](https://github.com/jfcherng/copilot-node-server).
The frontend is connected to the local extension server via websocket for updates to notebooks and to fetch completions from the LSP server.
## `jupyter_copilot`
This is the code for the local server. `handler.py` has the handles any websocket messages from the frontend through a queue as to not break stuff. The handling of websocket messages is done in `NotebookLSPHandler`. There is another class `NotebookHandler` which creates an in-memory representation of the code from a notebook. This works by having an array for each code block, then indexing into the array and changing its content when theres an update. This class also uses the `lsp_client` to communicate with the LSP server.
The actual node.js Copilot LSP server is spawned in as a process in `lsp.py`. The server is located in `node_modules/copilot-node-server/dist/copilot/language-server.js` and is spawned as. `lsp.py` provides an interface to communicate with this LSP server, and restart if it crashes.
**When you make changes to this folder `npm run watch` will not detect the change, so you need to restart the Jupyter instance in the terminal to see changes take effect**
## TODO
- Completions inside brackets
- Find out a better keybind system
- Copilot chat (?)
- Custom providers (?)
- Port to notebooks (?)
---
\
Huge thank you to these projects ❤️
[copilot.vim](https://github.com/github/copilot.vim)
[LSP-copilot](https://github.com/TerminalFi/LSP-copilot)
[copilot-node-server](https://github.com/jfcherng/copilot-node-server)
[copilot.lua](https://www.google.com/search?q=copilot.lua&oq=copilot.lua&aqs=chrome..69i57j0i512j35i39i512i650j69i60j5i44l2.1196j0j4&sourceid=chrome&ie=UTF-8)
[stackoverflow post](https://stackoverflow.com/questions/76741410/how-to-invoke-github-copilot-programmatically)
[GitHub Copilot](https://github.com/features/copilot)
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-copilot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "jupyter_copilot <dylanhuyn@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f0/9d/262564ffc6785800253d27750cc6da0465a24716996f62b308fb27196e20/jupyter_copilot-0.1.4.tar.gz",
"platform": null,
"description": "# jupyter_copilot\n\n[PyPi Package](https://pypi.org/project/jupyter-copilot/)\n\nA GitHub Copilot extension for JupyterLab. This extension uses the language server provided by [copilot.vim](https://github.com/github/copilot.vim) and the [@jupyter/completer](https://jupyterlab.readthedocs.io/en/latest/user/completer.html) module to provide native GitHub Copilot autocomplete into notebooks.\n\n\n\n\n**\u26a0\ufe0f WARNING: You should not use this for remote notebooks over SSH as authentication for the extension server is currently disabled. Also, This extension also only supports JupyterLab and not classic notebooks :(**\n\n**This extension is still very new and may be rough around the edges. If you experience any bugs or have any feature requests please feel free to open an issue or make a PR :)**\n\n## Features\n\n- Inline completions with GitHub Copilot \ud83e\udd16\n- Native GitHub authentication \ud83d\udd10\n- Custom keybindings \ud83d\udd25\n- Multilanguage support\n\n## **Requirements**\n\n- JupyterLab >= 4.0.0\n- Node.js >= 18.x\n\n## Setup\n\nTo install the extension, execute:\n\n```bash\npip install jupyter_copilot\n```\n\nTo login to copilot open the command palette with `Ctrl+Shift+C` (`Cmd+Shift+C` on mac) then select the `Sign In With Github` command and follow the instructions.\n\n\n\n\nOnce signed in open any notebook and the extension should run!\n\n## Settings\n\nTo change settings go to `Settings > Settings Editor` then search for Copilot.\n\n| Setting | Description |\n| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Enable/Disable | Enables or disables the extension |\n| Accept Keybind | The keybind you want to use to accept a completion, default value is `Ctrl + J`. This setting is just a string and is not validated to see if works. Currently using `Tab` for completions does not work, and you must refresh the notebook to see changes in effect. |\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyter_copilot\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# First install jupyterlab with pip\n# Clone the repo to your local environment\n# Change directory to the jupyter_copilot directory\n# Install package in development mode\npip install -e \".\"\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable jupyter_copilot\n# Rebuild extension Typescript source after making changes\njlpm build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable jupyter_copilot\npip uninstall jupyter_copilot\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupyter_copilot` within that folder.\n\n### Layout and structure\n\n\n\nThis extension is composed of a Python package named `jupyter_copilot`\nfor the server extension and a NPM package named `jupyter_copilot`\nfor the frontend extension.\n\nThe extension uses the language server provided by [copilot.vim](https://github.com/github/copilot.vim) for authentication and to actually fetch completions from GitHub. The language server is packaged as a node module caleld [copilot-node-server](https://github.com/jfcherng/copilot-node-server).\n\nThe frontend is connected to the local extension server via websocket for updates to notebooks and to fetch completions from the LSP server.\n\n## `jupyter_copilot`\n\nThis is the code for the local server. `handler.py` has the handles any websocket messages from the frontend through a queue as to not break stuff. The handling of websocket messages is done in `NotebookLSPHandler`. There is another class `NotebookHandler` which creates an in-memory representation of the code from a notebook. This works by having an array for each code block, then indexing into the array and changing its content when theres an update. This class also uses the `lsp_client` to communicate with the LSP server.\n\nThe actual node.js Copilot LSP server is spawned in as a process in `lsp.py`. The server is located in `node_modules/copilot-node-server/dist/copilot/language-server.js` and is spawned as. `lsp.py` provides an interface to communicate with this LSP server, and restart if it crashes.\n\n**When you make changes to this folder `npm run watch` will not detect the change, so you need to restart the Jupyter instance in the terminal to see changes take effect**\n\n## TODO\n\n- Completions inside brackets\n- Find out a better keybind system\n- Copilot chat (?)\n- Custom providers (?)\n- Port to notebooks (?)\n\n---\n\n\\\nHuge thank you to these projects \u2764\ufe0f\n\n[copilot.vim](https://github.com/github/copilot.vim)\n\n[LSP-copilot](https://github.com/TerminalFi/LSP-copilot)\n\n[copilot-node-server](https://github.com/jfcherng/copilot-node-server)\n\n[copilot.lua](https://www.google.com/search?q=copilot.lua&oq=copilot.lua&aqs=chrome..69i57j0i512j35i39i512i650j69i60j5i44l2.1196j0j4&sourceid=chrome&ie=UTF-8)\n\n[stackoverflow post](https://stackoverflow.com/questions/76741410/how-to-invoke-github-copilot-programmatically)\n\n[GitHub Copilot](https://github.com/features/copilot)\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018 jupyter_copilot Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.HE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "GitHub Copilot for Jupyter",
"version": "0.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/baolong281/jupyter-copilot/issues",
"Homepage": "https://github.com/baolong281/jupyter-copilot",
"Repository": "https://github.com/baolong281/jupyter-copilot.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d56516be723662ca5b202e7f96ade54be3fc6333004ec0145ed00a9a562a3c3",
"md5": "0ad22b1259df4eb293d3eae2180bda56",
"sha256": "e8309274799d57472061569a7ac646143009d9bae31b4b1919764e5126ca6742"
},
"downloads": -1,
"filename": "jupyter_copilot-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ad22b1259df4eb293d3eae2180bda56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9779992,
"upload_time": "2024-09-20T18:49:59",
"upload_time_iso_8601": "2024-09-20T18:49:59.310445Z",
"url": "https://files.pythonhosted.org/packages/1d/56/516be723662ca5b202e7f96ade54be3fc6333004ec0145ed00a9a562a3c3/jupyter_copilot-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f09d262564ffc6785800253d27750cc6da0465a24716996f62b308fb27196e20",
"md5": "394184b8ed52ec7743a36ecc1489603c",
"sha256": "24a49f6ac1816e6564a516e0953a191b9ffd2b84aeada7494394f4507119ea9e"
},
"downloads": -1,
"filename": "jupyter_copilot-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "394184b8ed52ec7743a36ecc1489603c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5680749,
"upload_time": "2024-09-20T18:50:06",
"upload_time_iso_8601": "2024-09-20T18:50:06.035553Z",
"url": "https://files.pythonhosted.org/packages/f0/9d/262564ffc6785800253d27750cc6da0465a24716996f62b308fb27196e20/jupyter_copilot-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 18:50:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "baolong281",
"github_project": "jupyter-copilot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-copilot"
}
