-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Split the project in two packages, one for jupyter-chat UI and one as…
… a jupyterlab extension
- Loading branch information
Showing
65 changed files
with
6,233 additions
and
1,716 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "$schema": "node_modules/lerna/schemas/lerna-schema.json", | ||
| "useWorkspaces": true, | ||
| "version": "0.1.0", | ||
| "npmClient": "yarn", | ||
| "useNx": true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| *.bundle.* | ||
| lib/ | ||
| node_modules/ | ||
| *.log | ||
| .eslintcache | ||
| .stylelintcache | ||
| *.egg-info/ | ||
| .ipynb_checkpoints | ||
| *.tsbuildinfo | ||
| jupyter_chat_extension/labextension | ||
| # Version file is handled by hatchling | ||
| jupyter_chat_extension/_version.py | ||
|
|
||
| # Integration tests | ||
| ui-tests/test-results/ | ||
| ui-tests/playwright-report/ | ||
|
|
||
| # Created by https://www.gitignore.io/api/python | ||
| # Edit at https://www.gitignore.io/?templates=python | ||
|
|
||
| ### Python ### | ||
| # Byte-compiled / optimized / DLL files | ||
| __pycache__/ | ||
| *.py[cod] | ||
| *$py.class | ||
|
|
||
| # C extensions | ||
| *.so | ||
|
|
||
| # Distribution / packaging | ||
| .Python | ||
| build/ | ||
| develop-eggs/ | ||
| dist/ | ||
| downloads/ | ||
| eggs/ | ||
| .eggs/ | ||
| lib/ | ||
| lib64/ | ||
| parts/ | ||
| sdist/ | ||
| var/ | ||
| wheels/ | ||
| pip-wheel-metadata/ | ||
| share/python-wheels/ | ||
| .installed.cfg | ||
| *.egg | ||
| MANIFEST | ||
|
|
||
| # PyInstaller | ||
| # Usually these files are written by a python script from a template | ||
| # before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
| *.manifest | ||
| *.spec | ||
|
|
||
| # Installer logs | ||
| pip-log.txt | ||
| pip-delete-this-directory.txt | ||
|
|
||
| # Unit test / coverage reports | ||
| htmlcov/ | ||
| .tox/ | ||
| .nox/ | ||
| .coverage | ||
| .coverage.* | ||
| .cache | ||
| nosetests.xml | ||
| coverage/ | ||
| coverage.xml | ||
| *.cover | ||
| .hypothesis/ | ||
| .pytest_cache/ | ||
|
|
||
| # Translations | ||
| *.mo | ||
| *.pot | ||
|
|
||
| # Scrapy stuff: | ||
| .scrapy | ||
|
|
||
| # Sphinx documentation | ||
| docs/_build/ | ||
|
|
||
| # PyBuilder | ||
| target/ | ||
|
|
||
| # pyenv | ||
| .python-version | ||
|
|
||
| # celery beat schedule file | ||
| celerybeat-schedule | ||
|
|
||
| # SageMath parsed files | ||
| *.sage.py | ||
|
|
||
| # Spyder project settings | ||
| .spyderproject | ||
| .spyproject | ||
|
|
||
| # Rope project settings | ||
| .ropeproject | ||
|
|
||
| # Mr Developer | ||
| .mr.developer.cfg | ||
| .project | ||
| .pydevproject | ||
|
|
||
| # mkdocs documentation | ||
| /site | ||
|
|
||
| # mypy | ||
| .mypy_cache/ | ||
| .dmypy.json | ||
| dmypy.json | ||
|
|
||
| # Pyre type checker | ||
| .pyre/ | ||
|
|
||
| # End of https://www.gitignore.io/api/python | ||
|
|
||
| # OSX files | ||
| .DS_Store | ||
|
|
||
| # Yarn cache | ||
| .yarn/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| BSD 3-Clause License | ||
|
|
||
| Copyright (c) 2024, Jupyter Development Team | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| # jupyter_chat_extension | ||
|
|
||
| [](https://github.com/QuantStack/jupyter-chat/actions/workflows/build.yml) | ||
|
|
||
| A chat extension for Jupyterlab | ||
|
|
||
| This package is composed of a Python package named `jupyter_chat_extension` | ||
| for the server side and a NPM package named `@jupyter/chat-extension` | ||
|
|
||
| ## Requirements | ||
|
|
||
| - JupyterLab >= 4.0.0 | ||
|
|
||
| ## Install | ||
|
|
||
| To install the package, execute: | ||
|
|
||
| ```bash | ||
| pip install jupyter_chat_extension | ||
| ``` | ||
|
|
||
| ## Uninstall | ||
|
|
||
| To remove the package, execute: | ||
|
|
||
| ```bash | ||
| pip uninstall jupyter_chat_extension | ||
| ``` | ||
|
|
||
| ## 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 jupyter-chat/jupyter-chat-extension directory | ||
| # Install package in development mode | ||
| pip install -e ".[test]" | ||
| # Rebuild Typescript source after making changes | ||
| jlpm build | ||
| ``` | ||
|
|
||
| By default, the `jlpm build` command generates the source maps for this package to make it easier to debug using the browser dev tools. | ||
|
|
||
| ### Development uninstall | ||
|
|
||
| ```bash | ||
| pip uninstall jupyter_chat_extension | ||
| ``` | ||
|
|
||
| ### Testing the package | ||
|
|
||
| #### Server tests | ||
|
|
||
| This extension is using [Pytest](https://docs.pytest.org/) for Python code testing. | ||
|
|
||
| Install test dependencies (needed only once): | ||
|
|
||
| ```sh | ||
| pip install -e ".[test]" | ||
| ``` | ||
|
|
||
| To execute them, run: | ||
|
|
||
| ```sh | ||
| pytest -vv -r ap --cov jupyter_chat_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) |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.