| Name | jupyter-litchi JSON |
| Version |
0.4.5
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension. |
| upload_time | 2024-10-10 10:20:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Mars Liu 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. |
| keywords |
agent
ai
jupyter
jupyterlab
jupyterlab-extension
llm
ollama
openai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# litchi
[](https://github.com/MarchLiu/litchi/actions/workflows/build.yml)
[](https://mybinder.org/v2/gh/MarchLiu/litchi/main?urlpath=lab)
Litchi is an AI extension for jupyter lab
## Requirements
- JupyterLab >= 4.0.0
- nodejs 20
- yarn
# Install
To install the extension, execute:
```bash
pip install jupyter_litchi
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyter_litchi
```
## How to use it
After install success. Just start `jupyter lab` in your computer and create a notebook.
You can see the toolbar in jupyterlab notebook:
Now, we can write content and choice a model from model list in toolbar.
And then use command palette or click the "send activate cell" button
Wait a moment. The replay will place into a new cell below current.
At default, Litchi use ollama at http://localhost:11434 . But you can set it connect to any OpenAI like api.
## 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
# Clone the repo to your local environment
# Change directory to the litchi directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# 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
pip uninstall jupyter-litchi
```
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 `litchi` within that folder.
### Testing the extension
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
## What's new
### 0.1.1
* rename project as `jupyter-litchi`
### 0.1.0
* chat with ollama in localhost:11434
* select model in list
### 0.1.3
* installer fixed
### 0.1.4
* add settings
### 0.2.0
* Add clean command for clean session
* Settings for list model api and chat api. Litchi could connect any openai api
### 0.3.0
I remove the implicit session of chat. Now we use notebook as chat session.
- command `Litchi Chat` just send current cell content and reply into below
- command `Litchi Contextual` set current cell content, and with every message above activated cell
- command `Litchi Historical` set current cell content, and with all cells of above
Very message send or received will marked their 'role' into metadata of the cell.
As command `Litchi Contextual`, the messages only include the cells were marked.
If we want to see the cells role information, could use command `Litchi Show Roles Toggle`.
### 0.3.1
- Modify the "send activate cell" button to three: Chat, Contextual, Historical.
- Add `Litchi Chat Selected` command
### 0.3.2
- Show message's role by prompt
### 0.3.4
- disable toolbar when litchi is waiting response.
- bugs fixed
### 0.3.5
- add chat commands to main menu
- fixed show roles toggle command's state
### 0.3.6
- bugs fixed
- now the pip package worked!
### 0.3.8
The bug of models selector fixed.
### 0.4.0
Settings page has been improved. Now we use textarea as system prompt editor.
### 0.4.1
- Merge litchi toolbar into notebook toolbar
- The problem what toolbar missed if new notebook created had been fixed
- Uniformed the chat buttons as notebook toolbar style
### 0.4.2
Throw a alert dialog if the communication failed.
### 0.4.3
- Add translate To English/Chinese command and cell button in markdown/raw cell.
- Support add more language translators in settings. They will be added into command palette.
- Add Unit Test Command and the cell button in code cell
### 0.4.5
- Add split cell command. The command split markdown cell content to markdown/mermaid and code cells. It is
useful if the AI response mixed markdown text and code
- Add continue mode. If continue mode is activated, add and active a new markdown cell below the AI response.
- Add a cell toolbar button for continuous historical chat until current cell even if continuous mode is deactivated.
## About Me
My name is Liu Xin, and my English name is Mars Liu and previously used March Liu. I translated the Python
2.2/2.3/2.4/2.5/2.7 Tutorial under this pseudonym.
In recent years, I published a book titled "Construction and Implementation of Micro Lisp Interpreter", which is based
on my Jaskell Core library ([https://github.com/MarchLiu/jaskell-core](https://github.com/MarchLiu/jaskell-core)). The
book introduces some knowledge about interpreter development.
I am one of the earliest users in both the Python Chinese Community and PostgreSQL Chinese Community. At QCon, I
demonstrated a neural network algorithm implemented using SQL CTE
syntax: [SQL CTE](https://github.com/MarchLiu/qcon2019shanghai/tree/master/sql-cte).
## Donate
Your sponsorship will contribute to the healthy growth of this project.
[](https://www.paypal.com/paypalme/marsliuzero)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-litchi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "agent, ai, jupyter, jupyterlab, jupyterlab-extension, llm, ollama, openai",
"author": null,
"author_email": "Mars Liu <mars.liu@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/38/fa/77ca141a8f660a393d5026c417e34ef8ae90e8d26b7b8346c936178be218/jupyter_litchi-0.4.5.tar.gz",
"platform": null,
"description": "# litchi\n\n[](https://github.com/MarchLiu/litchi/actions/workflows/build.yml)\n[](https://mybinder.org/v2/gh/MarchLiu/litchi/main?urlpath=lab)\n\n\nLitchi is an AI extension for jupyter lab\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n- nodejs 20\n- yarn\n\n# Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyter_litchi\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyter_litchi\n```\n\n## How to use it\n\nAfter install success. Just start `jupyter lab` in your computer and create a notebook.\n\nYou can see the toolbar in jupyterlab notebook:\n\n\n\nNow, we can write content and choice a model from model list in toolbar.\n\n\n\nAnd then use command palette or click the \"send activate cell\" button\n\nWait a moment. The replay will place into a new cell below current.\n\n\n\nAt default, Litchi use ollama at http://localhost:11434 . But you can set it connect to any OpenAI like api.\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# Clone the repo to your local environment\n# Change directory to the litchi 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# 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\npip uninstall jupyter-litchi\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 `litchi` within that folder.\n\n### Testing the extension\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n\n## What's new\n\n### 0.1.1\n\n* rename project as `jupyter-litchi`\n\n### 0.1.0\n\n* chat with ollama in localhost:11434\n* select model in list\n\n### 0.1.3\n\n* installer fixed \n\n### 0.1.4\n\n* add settings\n\n### 0.2.0\n\n* Add clean command for clean session\n* Settings for list model api and chat api. Litchi could connect any openai api\n\n### 0.3.0\n\nI remove the implicit session of chat. Now we use notebook as chat session.\n\n- command `Litchi Chat` just send current cell content and reply into below\n- command `Litchi Contextual` set current cell content, and with every message above activated cell\n- command `Litchi Historical` set current cell content, and with all cells of above\n\nVery message send or received will marked their 'role' into metadata of the cell.\n\nAs command `Litchi Contextual`, the messages only include the cells were marked.\n\nIf we want to see the cells role information, could use command `Litchi Show Roles Toggle`.\n\n\n### 0.3.1\n\n- Modify the \"send activate cell\" button to three: Chat, Contextual, Historical.\n- Add `Litchi Chat Selected` command \n\n### 0.3.2\n\n- Show message's role by prompt \n\n### 0.3.4\n\n- disable toolbar when litchi is waiting response.\n- bugs fixed\n\n### 0.3.5\n\n- add chat commands to main menu\n- fixed show roles toggle command's state\n\n### 0.3.6\n\n- bugs fixed\n- now the pip package worked!\n\n### 0.3.8\n\nThe bug of models selector fixed.\n\n### 0.4.0\n\nSettings page has been improved. Now we use textarea as system prompt editor.\n\n### 0.4.1\n\n- Merge litchi toolbar into notebook toolbar\n- The problem what toolbar missed if new notebook created had been fixed\n- Uniformed the chat buttons as notebook toolbar style \n\n### 0.4.2\n\nThrow a alert dialog if the communication failed.\n\n### 0.4.3\n\n- Add translate To English/Chinese command and cell button in markdown/raw cell. \n- Support add more language translators in settings. They will be added into command palette.\n- Add Unit Test Command and the cell button in code cell \n\n### 0.4.5\n\n- Add split cell command. The command split markdown cell content to markdown/mermaid and code cells. It is \n useful if the AI response mixed markdown text and code\n- Add continue mode. If continue mode is activated, add and active a new markdown cell below the AI response.\n- Add a cell toolbar button for continuous historical chat until current cell even if continuous mode is deactivated. \n\n## About Me\n\nMy name is Liu Xin, and my English name is Mars Liu and previously used March Liu. I translated the Python\n2.2/2.3/2.4/2.5/2.7 Tutorial under this pseudonym.\n\nIn recent years, I published a book titled \"Construction and Implementation of Micro Lisp Interpreter\", which is based\non my Jaskell Core library ([https://github.com/MarchLiu/jaskell-core](https://github.com/MarchLiu/jaskell-core)). The\nbook introduces some knowledge about interpreter development.\n\nI am one of the earliest users in both the Python Chinese Community and PostgreSQL Chinese Community. At QCon, I\ndemonstrated a neural network algorithm implemented using SQL CTE\nsyntax: [SQL CTE](https://github.com/MarchLiu/qcon2019shanghai/tree/master/sql-cte).\n\n## Donate\n\nYour sponsorship will contribute to the healthy growth of this project.\n\n[](https://www.paypal.com/paypalme/marsliuzero)",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Mars Liu 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.",
"summary": "A JupyterLab extension.",
"version": "0.4.5",
"project_urls": {
"Bug Tracker": "https://github.com/MarchLiu/litchi/issues",
"Homepage": "https://github.com/MarchLiu/litchi",
"Repository": "https://github.com/MarchLiu/litchi.git"
},
"split_keywords": [
"agent",
" ai",
" jupyter",
" jupyterlab",
" jupyterlab-extension",
" llm",
" ollama",
" openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32be50428060b9a5b37e537f806453016a8304c95779df086c1042d03059e546",
"md5": "aff998ca4ec4fcaf7899a7a46cbcbfb2",
"sha256": "ad9c1caf8f2b85a6c0b8acd04dbe24bdda4d1f637923762f711bf4fca42bf97f"
},
"downloads": -1,
"filename": "jupyter_litchi-0.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aff998ca4ec4fcaf7899a7a46cbcbfb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 123268,
"upload_time": "2024-10-10T10:20:08",
"upload_time_iso_8601": "2024-10-10T10:20:08.332227Z",
"url": "https://files.pythonhosted.org/packages/32/be/50428060b9a5b37e537f806453016a8304c95779df086c1042d03059e546/jupyter_litchi-0.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38fa77ca141a8f660a393d5026c417e34ef8ae90e8d26b7b8346c936178be218",
"md5": "569ef73458cfc96bfb0fb557cb967f7e",
"sha256": "e76e8bdcc69686e3ed84a86e4695f89bfdeffeb3a32dd828352344ef0ccc215c"
},
"downloads": -1,
"filename": "jupyter_litchi-0.4.5.tar.gz",
"has_sig": false,
"md5_digest": "569ef73458cfc96bfb0fb557cb967f7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 904411,
"upload_time": "2024-10-10T10:20:11",
"upload_time_iso_8601": "2024-10-10T10:20:11.280035Z",
"url": "https://files.pythonhosted.org/packages/38/fa/77ca141a8f660a393d5026c417e34ef8ae90e8d26b7b8346c936178be218/jupyter_litchi-0.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 10:20:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarchLiu",
"github_project": "litchi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-litchi"
}
