| Name | jupyterlab-codeium JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension to get AI code completions with Codeium |
| upload_time | 2024-06-26 07:45:37 |
| maintainer | None |
| docs_url | None |
| author | Jeremy Tuloup |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Jeremy Tuloup All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Copyright (c) 2024, Val Town Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Contains parts of modeling-app, licensed under the MIT License, Copyright (c) 2023 The Zoo Authors Contains parts of Cursor, licensed under the MIT License, Copyright (c) 2023 Cursor AI, Inc. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlab-codeium
[](https://github.com/jtpio/jupyterlab-codeium/actions/workflows/build.yml)
[](https://jtpio.github.io/jupyterlab-codeium/lab/index.html)
JupyterLab extension to get AI code completions with [Codeium](https://codeium.com/).
https://github.com/jtpio/jupyterlab-codeium/assets/591645/7ec0a6fa-9c51-49a8-89b4-77b431f4bda9
> [!WARNING]
> This extension is still very much experimental. It is not an official Codeium extension.
## ✨ Try it in your browser ✨
1. Follow the instructions in the [Usage](#usage) section to get your API key.
2. Open https://jtpio.github.io/jupyterlab-codeium in your browser
## Requirements
- JupyterLab >= 4.1.0
> [!NOTE]
> This extension is also compatible with [JupyterLite](https://github.com/jupyterlite/jupyterlite) >= 0.3.0
## Install
To install the extension, execute:
```bash
pip install jupyterlab-codeium
```
## Usage
> [!WARNING]
> Setting up the extension requires a Codeium API key. This part might still be challenging as retrieving the key requires a few manual steps at the moment.
> This might later be improved by providing a better auth flow.
1. Go to the Codeium website and sign up for an account: https://codeium.com/
2. Install the browser extension: https://codeium.com/chrome_tutorial
3. Open the settings for the chrome extension and click on "Get Token"
4. Right click on the extension window and select "Inspect" to open the dev tools for the extension. Then click on "Network"
5. Copy the token and paste it the input area, and then press "Enter Token"
6. This should log a new API request in the network tab. Click on "Preview" to get the API key.
7. Go to the settings to paste the API key:
8. You should now be able to use the extension. Open a Python file and start typing to see the completions.
## Contributing
### Packaging and releasing the extension
See [RELEASE](RELEASE.md)
### Credits
Many thanks to the `codemirror-codeium` project for the inspiration and the initial implementation of the Codeium integration with CodeMirror 6: https://github.com/val-town/codemirror-codeium
The protobuf files were copied from that repo and reused as is in this project.
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-codeium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jeremy Tuloup",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/48/1a/6938fb77d45ab042c7c75453806e7b2b38611d4bd0145ad607651a5cf987/jupyterlab_codeium-0.1.1.tar.gz",
"platform": null,
"description": "# jupyterlab-codeium\n\n[](https://github.com/jtpio/jupyterlab-codeium/actions/workflows/build.yml)\n[](https://jtpio.github.io/jupyterlab-codeium/lab/index.html)\n\nJupyterLab extension to get AI code completions with [Codeium](https://codeium.com/).\n\nhttps://github.com/jtpio/jupyterlab-codeium/assets/591645/7ec0a6fa-9c51-49a8-89b4-77b431f4bda9\n\n> [!WARNING]\n> This extension is still very much experimental. It is not an official Codeium extension.\n\n## \u2728 Try it in your browser \u2728\n\n1. Follow the instructions in the [Usage](#usage) section to get your API key.\n2. Open https://jtpio.github.io/jupyterlab-codeium in your browser\n\n## Requirements\n\n- JupyterLab >= 4.1.0\n\n> [!NOTE]\n> This extension is also compatible with [JupyterLite](https://github.com/jupyterlite/jupyterlite) >= 0.3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlab-codeium\n```\n\n## Usage\n\n> [!WARNING]\n> Setting up the extension requires a Codeium API key. This part might still be challenging as retrieving the key requires a few manual steps at the moment.\n> This might later be improved by providing a better auth flow.\n\n1. Go to the Codeium website and sign up for an account: https://codeium.com/\n2. Install the browser extension: https://codeium.com/chrome_tutorial\n3. Open the settings for the chrome extension and click on \"Get Token\"\n\n\n\n4. Right click on the extension window and select \"Inspect\" to open the dev tools for the extension. Then click on \"Network\"\n5. Copy the token and paste it the input area, and then press \"Enter Token\"\n6. This should log a new API request in the network tab. Click on \"Preview\" to get the API key.\n\n\n\n7. Go to the settings to paste the API key:\n\n\n\n8. You should now be able to use the extension. Open a Python file and start typing to see the completions.\n\n\n\n## Contributing\n\n### Packaging and releasing the extension\n\nSee [RELEASE](RELEASE.md)\n\n### Credits\n\nMany thanks to the `codemirror-codeium` project for the inspiration and the initial implementation of the Codeium integration with CodeMirror 6: https://github.com/val-town/codemirror-codeium\n\nThe protobuf files were copied from that repo and reused as is in this project.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Jeremy Tuloup All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Copyright (c) 2024, Val Town Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Contains parts of modeling-app, licensed under the MIT License, Copyright (c) 2023 The Zoo Authors Contains parts of Cursor, licensed under the MIT License, Copyright (c) 2023 Cursor AI, Inc.",
"summary": "A JupyterLab extension to get AI code completions with Codeium",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/jtpio/jupyterlab-codeium/issues",
"Homepage": "https://github.com/jtpio/jupyterlab-codeium",
"Repository": "https://github.com/jtpio/jupyterlab-codeium.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39f3d1bf836200e8836b3fffeb84cdf3e19d532349e96a48d6ccc27acb213085",
"md5": "cd737a08c3e86c6514bc7ed2b8668c34",
"sha256": "2dd2d5b9ad65f870da2eaea2b7875a13e3f63367850eace44956ca309778b46e"
},
"downloads": -1,
"filename": "jupyterlab_codeium-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd737a08c3e86c6514bc7ed2b8668c34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 56262,
"upload_time": "2024-06-26T07:45:34",
"upload_time_iso_8601": "2024-06-26T07:45:34.880438Z",
"url": "https://files.pythonhosted.org/packages/39/f3/d1bf836200e8836b3fffeb84cdf3e19d532349e96a48d6ccc27acb213085/jupyterlab_codeium-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "481a6938fb77d45ab042c7c75453806e7b2b38611d4bd0145ad607651a5cf987",
"md5": "2ecf7ddc60b02b2985b8f2b5658733a1",
"sha256": "91cf2677edaebf92eddf72e3f2d90ce31392f4341a282efe2360b4c1253aaa36"
},
"downloads": -1,
"filename": "jupyterlab_codeium-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2ecf7ddc60b02b2985b8f2b5658733a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 328955,
"upload_time": "2024-06-26T07:45:37",
"upload_time_iso_8601": "2024-06-26T07:45:37.793071Z",
"url": "https://files.pythonhosted.org/packages/48/1a/6938fb77d45ab042c7c75453806e7b2b38611d4bd0145ad607651a5cf987/jupyterlab_codeium-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 07:45:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jtpio",
"github_project": "jupyterlab-codeium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-codeium"
}
