-
Notifications
You must be signed in to change notification settings - Fork 502
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
Add CONTRIBUTING.md #161
Add CONTRIBUTING.md #161
Conversation
I'll take another pass at getting this set up for myself this week. I still haven't been able to get Voila working in dev mode :-/ |
Second pass done. This should be ready to go. @choldgraf did you give it another try? |
will give this a shot today |
Some notes:
|
It should normally be installed automatically (via |
Yeah - I think I just hadn't updated it recently which is why I had an outdated version. Maybe just add a "conda update XXX" for the required conda packages? Though I agree most developer types could have figured it out |
Ah one more point here after experimenting a bit more. It doesn't seem like this installs the |
Both the conda recipe and setup.py for jupyterlab_pygments require |
Indeed, development installations don't install data files. Jupyter server extensions rely on a configuration directory system in In the case of a development installation, the extension can be installed and enabled with:
the
|
I think we can fix all that by adding a custom devel command in setup.py, and symlinks on windows 10 seem to work fine, but requires admin mode (I think). Maybe a 'good first issue' to open? |
Yes, that would make sense. In the mean time, we could add these instructions for those who want to use the server extensions in development mode. |
Isn't the We can also add instructions for the notebook extension (which adds the "Voila" button to the classic notebook). |
If you're using this with jupyter_server (instead of notebook), you'll need to run |
Updated based on #182 and @yuvipanda's comment. |
CONTRIBUTING.md
Outdated
For Jupyter Server: | ||
|
||
```bash | ||
jupyter extension enable voila --sys-prefix [--py | --user] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove --user
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems to me that --py
is always required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--py
throws the following for me:
KeyError: 'The Python module voila does not include any valid server extensions'
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Full command: jupyter serverextension enable voila --sys-prefix --py
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indeed we don't have an entry point for a jupyter server extension in __init__.py
. We should probably just remove the --py
.
* Add CONTRIBUTING.md (still wip) * Add cd js/ to CONTRIBUTING.md * Update CONTRIBUTING.md * Add section about extensions * Update server extension instructions * Add "Tests" section * Remove --user, add JupyterLab extension
Woot, thanks for this @jtpio |
Fixes #134.
This is the set of commands I've used so far and they have been enough for regular development.
@choldgraf @SylvainCorlay @maartenbreddels feel free to jump in and add anything missing.
I'll do a second pass on it a bit later today / this week.