Update the development environment #1156
Conversation
There was a problem hiding this comment.
I guess we need to update the instructions for developing extension as well. This part is obselete. The command jupyter labextension develop --overwrite . does not work anymore due to the way we changed the organization of the repo. That is why I added a utility script to make a symlink of extension in dev mode. The docs of jupyter-server-proxy can be a good reference on updating the documentation of extension development.
docs/developing.md
Outdated
| pip install -U build wheel | ||
| python -m build | ||
| pip install dist/jupytext-x.x.x-py3-none-any.whl |
There was a problem hiding this comment.
Just out of curiosity, why build a wheel and install it instead of directly doing a pip install .?
There was a problem hiding this comment.
Well I am afraid it just tells that I know so little about wheels and tars etc. Before jupytext==1.16 I would use that to test the extension because the editable install would not include the extension, but from your comment it seems that I can remove that part, so I'll remove it!
There was a problem hiding this comment.
Ahh, ok I see. Yes, now we build the extension always, so we can directly do editable installs!
docs/developing.md
Outdated
| We use the [pre-commit](https://pre-commit.com) package to run pre-commit scripts like `black` and `flake8` on the code. | ||
| Install the `jupytext` package in development mode with | ||
| ``` | ||
| pip install '.[dev]' |
There was a problem hiding this comment.
I guess you are missing a editable flag here? pip install -e '.[dev]'?
There was a problem hiding this comment.
Oh yes you're right! Thanks
Nice ! The symlink is super helpful and it does make the development workflow much easier. I think that I will replace the obsolete paragraph with just Also I'll revert the change on |
mwouts
force-pushed
the
update_environment_and_hooks
branch
from
556e355
to
cd2f9aa
Compare
Codecov Report
@@ Coverage Diff @@
## main #1156 +/- ##
=======================================
Coverage 95.08% 95.08%
=======================================
Files 29 29
Lines 4419 4419
=======================================
Hits 4202 4202
Misses 217 217 📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today! |
No description provided.