escobar 0.1.0__tar.gz

escobar-0.1.0/.env.example

@@ -0,0 +1,4 @@
+# PyPI token for publishing packages
+# Get your token from https://pypi.org/manage/account/token/
+# Replace this with your actual token
+PYPI_TOKEN=pypi-AgEIcHlwaS5vcmcCJGV4YW1wbGUtdG9rZW4tMTIzNDU2Nzg5MDEK

escobar-0.1.0/.gitignore

@@ -0,0 +1,124 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+escobar/labextension
+# Version file is handled by hatchling
+escobar/_version.py
+
+# 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/
+
+# Environment variables
+.env

escobar-0.1.0/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+escobar

escobar-0.1.0/.yarnrc.yml

@@ -0,0 +1,3 @@
+enableImmutableInstalls: false
+
+nodeLinker: node-modules

escobar-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

escobar-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Escobar
+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.

escobar-0.1.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: escobar
+Version: 0.1.0
+Dynamic: Keywords
+Summary: AI CHAT EXTENSION
+Project-URL: Homepage, https://github.com/github_username/escobar
+Project-URL: Bug Tracker, https://github.com/github_username/escobar/issues
+Project-URL: Repository, https://github.com/github_username/escobar.git
+Author-email: Escobar <me@test.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, Escobar
+        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.
+License-File: LICENSE
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Escobar Chat Extension for JupyterLab
+
+A lightweight chat interface extension for JupyterLab.
+
+## Features
+
+- Simple chat-like interface
+- Send and receive messages
+- Keyboard shortcuts (Enter to send, Shift+Enter for new line)
+- Configurable settings
+- Accessible from the launcher and help menu
+
+## Requirements
+
+* JupyterLab >= 3.6.0 and < 4.0.0
+
+**Note:** This extension is compatible with JupyterLab 3.x. If you're using JupyterLab 4.x, you may need to downgrade or wait for a future update.
+
+## Installation
+
+### Quick Installation
+
+To quickly install the extension, use the provided installation script:
+
+```bash
+# Make the script executable if needed
+chmod +x install.sh
+
+# Run the installation script
+./install.sh
+```
+
+### Manual Installation
+
+Alternatively, you can install the extension manually:
+
+```bash
+# Install dependencies
+npm install
+
+# Build the extension
+npm run build
+
+# Install the extension in development mode
+pip3 install -e .
+```
+
+## Usage
+
+After installation, you can access the Escobar Chat in several ways:
+
+1. From the launcher (look for the "Escobar Chat" card)
+2. From the command palette (Ctrl+Shift+C, then search for "Escobar Chat")
+3. From the Help menu (Help > Escobar Chat)
+4. Using the keyboard shortcut (Ctrl+E)
+
+## Configuration
+
+You can configure the extension through the JupyterLab Settings menu:
+
+1. Go to Settings > Settings Editor
+2. Search for "Escobar Chat"
+3. Modify the following settings:
+   - Default Greeting: The message shown when opening a new chat
+   - Maximum Messages: The maximum number of messages to keep in the chat history
+
+## Development
+
+### Local Development Install
+
+```bash
+# Clone the repository
+git clone https://github.com/your-username/escobar.git
+cd escobar
+
+# Install dependencies
+npm install
+
+# Build the extension
+npm run build
+
+# Install the extension in development mode
+pip3 install -e .
+jupyter labextension develop . --overwrite
+
+# Run JupyterLab
+jupyter lab
+```
+
+### Watch Mode
+
+For development, you can run the extension in watch mode:
+
+```bash
+# In one terminal, watch for changes
+npm run watch
+
+# In another terminal, run JupyterLab
+jupyter lab
+```
+
+## Publishing to PyPI
+
+### Checking Package Name Availability
+
+Before publishing, you can check if your desired package name is available on PyPI:
+
+```bash
+# Check the name in pyproject.toml
+./check_pypi_name.sh
+
+# Or check a specific name
+./check_pypi_name.sh my-package-name
+```
+
+### Publishing Process
+
+To publish this extension to PyPI, follow these steps:
+
+1. Create a PyPI account if you don't have one at [https://pypi.org/account/register/](https://pypi.org/account/register/)
+
+2. Generate an API token at [https://pypi.org/manage/account/token/](https://pypi.org/manage/account/token/)
+
+3. Create a `.env` file in the project root with your PyPI token:
+   ```
+   PYPI_TOKEN=your-token-here
+   ```
+   (You can copy `.env.example` to `.env` and replace the token)
+
+4. Run the publishing script:
+   ```bash
+   ./publish_to_pypi.sh
+   ```
+
+The script will:
+- Check if your package name is available on PyPI
+- Build the extension
+- Upload it to PyPI using your token
+
+After successful publishing, users can install your extension with:
+```bash
+pip install escobar
+```
+
+## License
+
+BSD-3-Clause

escobar-0.1.0/README.md

@@ -0,0 +1,147 @@
+# Escobar Chat Extension for JupyterLab
+
+A lightweight chat interface extension for JupyterLab.
+
+## Features
+
+- Simple chat-like interface
+- Send and receive messages
+- Keyboard shortcuts (Enter to send, Shift+Enter for new line)
+- Configurable settings
+- Accessible from the launcher and help menu
+
+## Requirements
+
+* JupyterLab >= 3.6.0 and < 4.0.0
+
+**Note:** This extension is compatible with JupyterLab 3.x. If you're using JupyterLab 4.x, you may need to downgrade or wait for a future update.
+
+## Installation
+
+### Quick Installation
+
+To quickly install the extension, use the provided installation script:
+
+```bash
+# Make the script executable if needed
+chmod +x install.sh
+
+# Run the installation script
+./install.sh
+```
+
+### Manual Installation
+
+Alternatively, you can install the extension manually:
+
+```bash
+# Install dependencies
+npm install
+
+# Build the extension
+npm run build
+
+# Install the extension in development mode
+pip3 install -e .
+```
+
+## Usage
+
+After installation, you can access the Escobar Chat in several ways:
+
+1. From the launcher (look for the "Escobar Chat" card)
+2. From the command palette (Ctrl+Shift+C, then search for "Escobar Chat")
+3. From the Help menu (Help > Escobar Chat)
+4. Using the keyboard shortcut (Ctrl+E)
+
+## Configuration
+
+You can configure the extension through the JupyterLab Settings menu:
+
+1. Go to Settings > Settings Editor
+2. Search for "Escobar Chat"
+3. Modify the following settings:
+   - Default Greeting: The message shown when opening a new chat
+   - Maximum Messages: The maximum number of messages to keep in the chat history
+
+## Development
+
+### Local Development Install
+
+```bash
+# Clone the repository
+git clone https://github.com/your-username/escobar.git
+cd escobar
+
+# Install dependencies
+npm install
+
+# Build the extension
+npm run build
+
+# Install the extension in development mode
+pip3 install -e .
+jupyter labextension develop . --overwrite
+
+# Run JupyterLab
+jupyter lab
+```
+
+### Watch Mode
+
+For development, you can run the extension in watch mode:
+
+```bash
+# In one terminal, watch for changes
+npm run watch
+
+# In another terminal, run JupyterLab
+jupyter lab
+```
+
+## Publishing to PyPI
+
+### Checking Package Name Availability
+
+Before publishing, you can check if your desired package name is available on PyPI:
+
+```bash
+# Check the name in pyproject.toml
+./check_pypi_name.sh
+
+# Or check a specific name
+./check_pypi_name.sh my-package-name
+```
+
+### Publishing Process
+
+To publish this extension to PyPI, follow these steps:
+
+1. Create a PyPI account if you don't have one at [https://pypi.org/account/register/](https://pypi.org/account/register/)
+
+2. Generate an API token at [https://pypi.org/manage/account/token/](https://pypi.org/manage/account/token/)
+
+3. Create a `.env` file in the project root with your PyPI token:
+   ```
+   PYPI_TOKEN=your-token-here
+   ```
+   (You can copy `.env.example` to `.env` and replace the token)
+
+4. Run the publishing script:
+   ```bash
+   ./publish_to_pypi.sh
+   ```
+
+The script will:
+- Check if your package name is available on PyPI
+- Build the extension
+- Upload it to PyPI using your token
+
+After successful publishing, users can install your extension with:
+```bash
+pip install escobar
+```
+
+## License
+
+BSD-3-Clause

escobar-0.1.0/RELEASE.md

@@ -0,0 +1,77 @@
+# Making a new release of escobar
+
+The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+## Manual release
+
+### Python package
+
+This extension can be distributed as Python packages. All of the Python
+packaging instructions are in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, you first need to install some tools:
+
+```bash
+pip install build twine hatch
+```
+
+Bump the version using `hatch`. By default this will create a tag.
+See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
+
+```bash
+hatch version <new-version>
+```
+
+Make sure to clean up all the development files before building the package:
+
+```bash
+jlpm clean:all
+```
+
+You could also clean up the local git repository:
+
+```bash
+git clean -dfX
+```
+
+To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
+
+```bash
+python -m build
+```
+
+> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
+
+Then to upload the package to PyPI, do:
+
+```bash
+twine upload dist/*
+```
+
+### NPM package
+
+To publish the frontend part of the extension as a NPM package, do:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser.
+
+Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html) for more information.
+
+Here is a summary of the steps to cut a new release:
+
+- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the [Github Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) in the repository
+- Go to the Actions panel
+- Run the "Step 1: Prep Release" workflow
+- Check the draft changelog
+- Run the "Step 2: Publish Release" workflow
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

escobar-0.1.0/check_pypi_name.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# check_pypi_name.sh - Script to check if a package name is available on PyPI
+
+# Get package name from command line argument or from pyproject.toml
+if [ -n "$1" ]; then
+    PACKAGE_NAME="$1"
+else
+    # Get package name from pyproject.toml
+    PACKAGE_NAME=$(grep -m 1 'name = ' pyproject.toml | sed 's/name = "\(.*\)"/\1/')
+    echo "Using package name from pyproject.toml: $PACKAGE_NAME"
+fi
+
+echo "Checking availability for package name: $PACKAGE_NAME"
+
+# Check if package name is available on PyPI
+HTTP_STATUS=$(curl -s -o /dev/null -w "%{http_code}" "https://pypi.org/pypi/$PACKAGE_NAME/json")
+
+if [ "$HTTP_STATUS" -eq 200 ]; then
+    echo "Warning: Package name '$PACKAGE_NAME' is already taken on PyPI."
+    echo "Consider choosing a different name in pyproject.toml."
+else
+    echo "Good news! Package name '$PACKAGE_NAME' appears to be available on PyPI."
+fi
+
+echo "You can also check manually by visiting: https://pypi.org/project/$PACKAGE_NAME/"

escobar-0.1.0/escobar/__init__.py

@@ -0,0 +1,8 @@
+from ._version import __version__
+
+
+def _jupyter_labextension_paths():
+    return [{
+        "src": "labextension",
+        "dest": "escobar"
+    }]

escobar-0.1.0/escobar/_version.py

@@ -0,0 +1,4 @@
+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '0.1.0'