Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix cookiecutter template #637

Merged
merged 9 commits into from
Feb 14, 2024
Merged

Fix cookiecutter template #637

merged 9 commits into from
Feb 14, 2024

Conversation

dlqqq
Copy link
Collaborator

@dlqqq dlqqq commented Feb 12, 2024

Description

  • Fixes the cookiecutter template for developers who want to extend Jupyter AI
    • The new cookiecutter provides a template provider and slash command implementation.
  • Removes frontend labextension code from cookiecutter, as we no longer have any frontend plugins that are intended for developers to provide/override
  • Adds developer readthedocs documentation

Testing instructions

To test this PR:

cd packages/
# press enter repeatedly once the wizard opens
cookiecutter jupyter-ai-module-cookiecutter
cd jupyter-ai-test/
pip install -e .

Then, run jupyter lab with Jupyter AI installed, and verify that:

  1. The test provider can be selected from the Settings UI
  2. The test provider sends a basic reply
  3. The /test slash command can be invoked and sends a basic reply

Demo

Screenshot 2024-02-12 at 9 41 41 AM

@dlqqq dlqqq added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 12, 2024
JasonWeill
JasonWeill reviewed Feb 12, 2024
View reviewed changes
Copy link
Collaborator

@JasonWeill JasonWeill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified locally. Great work! A few suggestions about the docs.

docs/source/developers/index.md Show resolved Hide resolved
docs/source/developers/index.md Show resolved Hide resolved
docs/source/developers/index.md Show resolved Hide resolved
docs/source/developers/index.md Show resolved Hide resolved
packages/jupyter-ai-module-cookiecutter/README.md Show resolved Hide resolved
...-module-cookiecutter/{{cookiecutter.root_dir_name}}/{{cookiecutter.python_name}}/provider.py Show resolved Hide resolved
packages/jupyter-ai/jupyter_ai/__init__.py Show resolved Hide resolved
@JasonWeill JasonWeill mentioned this pull request Feb 12, 2024
Closed
@JasonWeill JasonWeill linked an issue Feb 12, 2024 that may be closed by this pull request
Custom slash command build failed #613
Closed
dlqqq and others added 2 commits February 13, 2024 14:31
@dlqqq @krassowski
fix cookiecutter GH link
4b4af46 
Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
@dlqqq
add pip install cookiecutter
45238b4
andrii-i
andrii-i approved these changes Feb 14, 2024
View reviewed changes
Copy link
Collaborator

@andrii-i andrii-i left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally and this looks and works well, fixes errors mentioned in #613. Good job, props for adding explicit comments / explanations to TestLLM example class, this improves developer on-boarding experience.

@dlqqq dlqqq merged commit 6639c66 into jupyterlab:main Feb 14, 2024
8 checks passed
@dlqqq
Copy link
Collaborator Author

dlqqq commented Feb 14, 2024

@meeseeksdev please backport to 1.x

@lumberbot-app Lumberbot (App)
Copy link

lumberbot-app bot commented Feb 14, 2024

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 1.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 6639c66cc93b3dd5951dde9181ae0abd09fdbde2
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #637: Fix cookiecutter template'
  1. Push to a named branch:
git push YOURFORK 1.x:auto-backport-of-pr-637-on-1.x
  1. Create a PR against branch 1.x, I would have named this PR:

"Backport PR #637 on branch 1.x (Fix cookiecutter template)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@dlqqq dlqqq mentioned this pull request Feb 14, 2024
Merged
dlqqq added a commit that referenced this pull request Feb 14, 2024
@dlqqq @krassowski
Backport PR #637 on branch 1.x (Fix cookiecutter template) (#640)
9867456 
* delete binder related boilerplate

* remove unused github workflows

* remove frontend boilerplate, update provider template

* add slash command template

* tweak wording

* add contributor docs for cookiecutter use

* pre-commit

* fix cookiecutter GH link

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* add pip install cookiecutter

---------

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
dbelgrod pushed a commit to dbelgrod/jupyter-ai that referenced this pull request Jun 10, 2024
@dlqqq @krassowski
Fix cookiecutter template (jupyterlab#637)
04e3881 
* delete binder related boilerplate

* remove unused github workflows

* remove frontend boilerplate, update provider template

* add slash command template

* tweak wording

* add contributor docs for cookiecutter use

* pre-commit

* fix cookiecutter GH link

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>

* add pip install cookiecutter

---------

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krassowski krassowski krassowski left review comments

@andrii-i andrii-i andrii-i approved these changes

@JasonWeill JasonWeill JasonWeill left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request Still Needs Manual Backport
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Custom slash command build failed
4 participants
@dlqqq @krassowski @andrii-i @JasonWeill