jupytutor 0.1.4__tar.gz

jupytutor-0.1.4/.copier-answers.yml

@@ -0,0 +1,15 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.3.8
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: kevin.gillespie@berkeley.edu
+author_name: Kevin Gillespie
+has_binder: true
+has_settings: false
+kind: frontend
+labextension_name: jupytutor
+project_short_description: A Jupyter extension for providing students LLM feedback
+    based on autograder results and supplied course context.
+python_name: jupytutor
+repository: https://github.com/kevyg03/jupytutor
+test: true
+

jupytutor-0.1.4/.gitignore

@@ -0,0 +1,125 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupytutor/labextension
+# Version file is handled by hatchling
+jupytutor/_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/

jupytutor-0.1.4/.prettierignore

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

jupytutor-0.1.4/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

jupytutor-0.1.4/BUILD_GUIDE.md

@@ -0,0 +1,253 @@
+# Build and Publishing Guide for jupytutor
+
+## Overview
+
+This guide explains how to build and publish the jupytutor package to PyPI, ensuring all React components and JavaScript assets are included.
+
+## What Was Fixed
+
+The original configuration was missing the `hatch-jupyter-builder` in the build requirements, which caused the JavaScript/React components to not be built during package creation. The following changes were made:
+
+1. **pyproject.toml updates:**
+   - Added `hatch-jupyter-builder>=0.5` to `build-system.requires`
+   - Added `[tool.hatch.build.targets.wheel]` section with artifacts
+   - Added `install-pre-commit-hook = false` to jupyter-builder configuration
+
+2. **Created MANIFEST.in:**
+   - Ensures all source files, styles, and built assets are included in the source distribution
+
+## Prerequisites
+
+Before building, ensure you have:
+
+- Python >= 3.9
+- Node.js and npm/yarn
+- `jlpm` (JupyterLab package manager)
+
+Install build dependencies:
+
+```bash
+pip install build hatchling hatch-jupyter-builder jupyterlab
+```
+
+## Building the Package
+
+### 1. Clean Previous Builds
+
+```bash
+# Clean JavaScript build artifacts
+jlpm clean:all
+
+# Clean Python build artifacts
+rm -rf dist/ build/ *.egg-info
+rm -rf jupytutor/labextension
+```
+
+### 2. Build JavaScript/TypeScript Components
+
+```bash
+# Install npm dependencies
+jlpm install
+
+# Build the labextension
+jlpm build:prod
+```
+
+This will:
+
+- Compile TypeScript to JavaScript
+- Bundle React components
+- Create the labextension in `jupytutor/labextension/`
+
+### 3. Build Python Package
+
+```bash
+# Build both wheel and source distribution
+python -m build
+```
+
+This will:
+
+- Trigger the `hatch-jupyter-builder` to build the extension
+- Create the wheel (`.whl`) in `dist/`
+- Create the source distribution (`.tar.gz`) in `dist/`
+
+### 4. Verify the Build
+
+Check that the wheel contains the labextension:
+
+```bash
+# List contents of the wheel
+unzip -l dist/jupytutor-*.whl | grep labextension
+
+# You should see entries like:
+# share/jupyter/labextensions/jupytutor/static/...
+# share/jupyter/labextensions/jupytutor/package.json
+```
+
+Or use a tool like `check-wheel-contents`:
+
+```bash
+pip install check-wheel-contents
+check-wheel-contents dist/jupytutor-*.whl
+```
+
+## Publishing to PyPI
+
+### Test PyPI (Recommended First)
+
+1. Register at https://test.pypi.org/
+2. Create an API token
+3. Upload:
+
+```bash
+pip install twine
+twine upload --repository testpypi dist/*
+```
+
+4. Test installation:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ jupytutor
+```
+
+### Production PyPI
+
+1. Register at https://pypi.org/
+2. Create an API token
+3. Upload:
+
+```bash
+twine upload dist/*
+```
+
+## Development Installation
+
+For development, use editable install:
+
+```bash
+# Install in development mode
+pip install -e .
+
+# In another terminal, watch for changes
+jlpm watch
+```
+
+## Troubleshooting
+
+### React Components Not Showing Up
+
+If React components aren't appearing after installation:
+
+1. Check that labextension is installed:
+
+```bash
+jupyter labextension list
+```
+
+2. Rebuild the extension:
+
+```bash
+jlpm build:prod
+```
+
+3. Verify the built files exist:
+
+```bash
+ls -la jupytutor/labextension/static/
+```
+
+4. Check browser console for errors
+
+### Build Failures
+
+If the build fails:
+
+1. Ensure all dependencies are installed:
+
+```bash
+jlpm install
+pip install -e ".[dev]"
+```
+
+2. Clear all caches:
+
+```bash
+jlpm clean:all
+rm -rf node_modules
+rm -rf ~/.jupyter/lab/staging
+jlpm install
+```
+
+3. Check for TypeScript errors:
+
+```bash
+jlpm build:lib
+```
+
+## Key Files
+
+- `pyproject.toml` - Python package configuration
+- `package.json` - JavaScript package configuration
+- `MANIFEST.in` - Source distribution file inclusion rules
+- `jupytutor/labextension/` - Built JavaScript assets (auto-generated)
+- `src/` - TypeScript/React source code
+- `style/` - CSS styles
+
+## CI/CD Integration
+
+For automated publishing, you can use GitHub Actions. Example workflow:
+
+```yaml
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: |
+          pip install build twine
+          npm install -g yarn
+
+      - name: Build
+        run: |
+          jlpm install
+          jlpm build:prod
+          python -m build
+
+      - name: Publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: twine upload dist/*
+```
+
+## Version Management
+
+The package version is managed through `package.json` using `hatch-nodejs-version`. To bump the version:
+
+```bash
+# Update version in package.json
+npm version patch  # or minor, or major
+
+# Commit the change
+git add package.json
+git commit -m "Bump version to X.Y.Z"
+git tag vX.Y.Z
+git push && git push --tags
+```

jupytutor-0.1.4/CHANGELOG.md

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

jupytutor-0.1.4/LICENSE

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

jupytutor-0.1.4/MANIFEST.in

@@ -0,0 +1,32 @@
+include LICENSE
+include README.md
+include pyproject.toml
+include install.json
+include babel.config.js
+include jest.config.js
+include tsconfig.json
+include tsconfig.test.json
+include webpack.config.js
+include package.json
+include yarn.lock
+
+graft jupytutor/labextension
+graft jupytutor
+graft jupyter-server-config
+graft src
+graft style
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints
+
+# Exclude specific directories
+prune .github
+prune binder
+prune node_modules
+prune lib
+prune ui-tests
+

jupytutor-0.1.4/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: jupytutor
+Version: 0.1.4
+Summary: A Jupyter extension for providing students LLM feedback based on autograder results and supplied course context.
+Project-URL: Homepage, https://github.com/kevyg03/jupytutor
+Project-URL: Bug Tracker, https://github.com/kevyg03/jupytutor/issues
+Project-URL: Repository, https://github.com/kevyg03/jupytutor.git
+Author-email: Kevin Gillespie <kevin.gillespie@berkeley.edu>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, Kevin Gillespie
+        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
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: jupyter-server<3,>=2.0.0
+Description-Content-Type: text/markdown
+
+# jupytutor
+
+[![Github Actions Status](https://github.com/kevyg03/jupytutor/workflows/Build/badge.svg)](https://github.com/kevyg03/jupytutor/actions/workflows/build.yml)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/kevyg03/jupytutor/main?urlpath=lab)
+
+A Jupyter extension for providing students LLM feedback based on autograder results and supplied course context.
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+- Python >= 3.9
+
+## Installation
+
+```bash
+pip install jupytutor
+```
+
+## Configuration
+
+jupytutor supports custom configuration through a JSON file in your home directory.
+
+### Quick Setup
+
+1. Create the config directory:
+
+   ```bash
+   mkdir -p ~/.config/jupytutor
+   ```
+
+2. Create the config file at
+
+   ```
+   ~/.config/jupytutor/config.json
+   ```
+
+3. Edit the config file with your settings (reference the jupytutor repository (https://github.com/kevyg03/jupytutor), src/config.ts)
+
+4. Restart JupyterLab
+
+The config.json can only contain keys that exist in src/config.ts. Keys that aren't provided will default to the values set by config.ts.
+
+## Testing Locally
+
+Create a new conda environment (conda create -n <env_name>) and enter it, then run:
+
+```bash
+pip install jupytutor
+```
+
+From another terminal in the same environment, run
+
+```bash
+jupyter lab
+```
+
+Right click and hit "Inspect Element" and navigate to "Console" to confirm everything is activated.
+
+## 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 jupytutor 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 jupytutor
+```
+
+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 `jupytutor` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)