CONTRIBUTING.md

Development

Python

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-nteract-data-explorer
python3 -mvenv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Or if you are using pyenv:

pyenv virtualenv 3.9.10 datasette-nteract-data-explorer
pyenv

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

Javascript

To ensure stability when resolving 3rd party dependencies, we use the Yarn package manager.

yarn install

To build a local test page

yarn run dev

To build the package for production, then export the built files to where the Python package can use them

yarn run build
yarn run export

Releasing new versions

To publish a new package to PyPI

1. Open a PR like this one: #11 which bumps the package version
2. Tag the PR after merging locally, then push

git tag 0.3.1
git push --tags

3. Open the releases page, and create a new release

Once created, the release will automatically trigger the PyPi publish workflow