Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 1.4 KB
Raw

Contributing

Prerequisites

Poetry

Install poetry

pipx install poetry

Learn more about poetry at https://python-poetry.org/

Make

make is included with xcode. If you don't already have it install it:

xcode-select --install

Development for JupyterLab

  1. run a local JupyterLab instance:

    make jupyterlab-dev

    then go to http://localhost:8888

  2. make changes to the skillsnetwork package

  3. restart your kernel

  4. test your changes

Development for JupyterLite

  1. run a local pypi instance:

    make local-pypi

  2. run a local JupyterLite instance:

    make jupyterlite-dev

    then go to http://localhost:8000

  3. install the package in JupyterLite (note: your version may be different. You can go to http://localhost:3000/skillsnetwork to see available versions):

    import piplite
await piplite.install("http://localhost:3000/skillsnetwork/skillsnetwork-0.0.0-py3-none-any.whl")

  4. make changes to the skillsnetwork package

  5. stop the local pypi server with Ctrl+c, then re-start it with make local-pypi

  6. restart your kernel

  7. reinstall the package to get the latest changes

  8. test your changes

Publishing

To publish a new version of the package on PyPI, create a new GitHub release. Pre-releasese are supported and will also be published to PyPI (as pre-releases).