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.

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

Contributor documentation: Add guidance on contributing a new provider #677

Open
dlqqq opened this issue Mar 5, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@dlqqq
Copy link
Member

dlqqq commented Mar 5, 2024

Problem

Open source contributors are opening PRs to add new providers to Jupyter AI. This is extremely helpful to everybody, and we greatly appreciate others taking the time to write and test these. However, contributors have had difficulty doing so due to subtle and mostly undocumented details of how the Python source works.

The contributor documentation should have a new section that:

  1. Describes how to contribute a new provider, end-to-end,
  2. Indicates that contributors need to run jlpm dev-install again to make new providers show in the UI after declaring the entry point in pyproject.toml, and
  3. Indicates that contributors should define providers in separate files to keep third-party dependencies optional.
@dlqqq dlqqq added the documentation Improvements or additions to documentation label Mar 5, 2024
@dlqqq dlqqq changed the title Contributor documentation: Add guidance on contributing a provider Contributor documentation: Add guidance on contributing a new provider Mar 5, 2024
@giswqs
Copy link
Contributor

giswqs commented Mar 6, 2024

Just wanted to point out that the installation instruction with nodejs=20 does not work on my linux machine. Removing the version pin installs nodejs v18.18.2, which works fine with jupyter-ai. The reason is that the latest version of nodejs on the anaconda channel is v18.18.2, while the latest version on the conda-forge channel is v0.20.9. So we either have to remove the nodejs version pin or force it to install from the conda-forge channel.

conda create -n jupyter-ai python=3.11 nodejs=20

image

conda create -n jupyter-ai python=3.11 nodejs

image

conda create -n jupyter-ai python=3.11 conda-forge::nodejs

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants