Merge branch 'main' into feature/223-unify-pandas-dtype-inference

.github/actions/setup-poetry/action.yml

@@ -38,7 +38,7 @@ runs:
               python-version: ${{ inputs.python-version }}
         - name: Install dependencies
           if: inputs.install-dependencies != 'false' && steps.setup-python-with-cache.outputs.cache-hit != 'true'
-          run: poetry install --sync --without playbook --no-interaction
+          run: poetry install --sync --all-extras --without playbook --no-interaction
           shell: bash
         - name: Get Spotlight version
           id: get-package-version

.github/workflows/ci.yml

@@ -1,6 +1,8 @@
 name: CI
 
-on: push
+on:
+    - push
+    - pull_request
 
 # As long as we use local actions, checkout should be made in workflow before
 # and not in the local actions. Otherwise, no action file found.
@@ -286,7 +288,7 @@ jobs:
               with:
                   name: datasets-${{ needs.prepare-python.outputs.version }}
                   path: build/datasets/
-            - name: '📤 Restore pro frontend'
+            - name: '📤 Restore frontend'
               uses: actions/download-artifact@v3
               with:
                   name: .frontend-${{ needs.prepare-python.outputs.version }}
@@ -334,9 +336,19 @@ jobs:
                   fi
             - name: '📸 Upload GUI screenshots'
               if: |
-                  success()
-                  || steps.setup-chromedriver.outcome == 'success'
-                  || steps.setup-geckodriver.outcome == 'success'
+                  (
+                    success()
+                    || steps.setup-chromedriver.outcome == 'success'
+                    || steps.setup-geckodriver.outcome == 'success'
+                  ) && (
+                    (
+                      github.event_name == 'push'
+                      && github.repository == 'Renumics/spotlight'
+                    ) || (
+                      github.event_name == 'pull_request'
+                      && github.event.pull_request.head.repo.full_name == 'Renumics/spotlight'
+                    )
+                  )
               uses: LanceMcCarthy/Action-AzureBlobUpload@v2
               with:
                   connection_string: ${{ secrets.AZURE_CONNECTION_STRING }}
@@ -395,7 +407,7 @@ jobs:
               run: python -m pip install --upgrade pip setuptools wheel
             - name: Install Spotlight
               id: setup
-              run: python -m pip install --find-links build/dist/ renumics-spotlight==${{ needs.prepare-python.outputs.version }}
+              run: python -m pip install --find-links build/dist/ renumics-spotlight[all]==${{ needs.prepare-python.outputs.version }}
             - name: Test Spotlight start (Windows)
               if: runner.os == 'Windows' && (success() || steps.setup.outcome == 'success')
               run: ./scripts/Test-SpotlightStart.ps1
@@ -422,7 +434,7 @@ jobs:
     # Release stage
     release:
         name: '🚀 Release Spotlight'
-        if: startsWith(github.ref, 'refs/tags/v')
+        if: startsWith(github.ref, 'refs/tags/v') && github.repository_owner == 'Renumics'
         needs:
             - prepare-python
             - prepare-node

.github/workflows/pr.yml

@@ -6,6 +6,7 @@ jobs:
     # Comment
     comment-gui-screenshots:
         name: '🖍 Comment GUI screenshots'
+        if: github.event.pull_request.head.repo.full_name == 'Renumics/spotlight'
         permissions:
             pull-requests: write
         runs-on: ubuntu-latest

.gitignore

@@ -44,7 +44,7 @@ __pycache__/
 # testing
 /coverage
 geckodriver.log
-/ui_tests/_autogenerated_ui_elements.py
+/tests/ui/_autogenerated_ui_elements.py
 
 # misc
 .DS_Store

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contribute to Spotlight
+
+Everyone is welcome to contribute, and we value everybody's contribution. Code
+contributions are not the only way to help the community.
+Reported bugs, suggested features, contributing design ideas,
+or offering feedback are alse extremely valuable to us.
+
+Technical details on how to contribute can be found in our [documentation](https://renumics.com/docs/development).
+
+## Ways to contribute
+
+There are several ways you can contribute to Spotlight:
+
+* Fix outstanding issues.
+* Implement new features.
+* Submit issues related to bugs or desired new features.
+* Share your use case
+
+If you don't know where to start, you might want to have a look at [hacktoberfest issues](https://github.com/Renumics/spotlight/issues?q=is%3Aissue+is%3Aopen+label%3Ahacktoberfest)
+and our guide on how to create a [new Lens](https://renumics.com/docs/development/lenses).

Makefile

@@ -12,12 +12,12 @@ help: ## Print this help message
 
 .PHONY: init
 init: ## Locally install all dev dependencies
-	poetry install --without playbook
+	poetry install --all-extras --without playbook
 	pnpm install
 
 .PHONY: init-playbook
 init-playbook: ## Locally install all playbook dev dependencies
-	poetry install
+	poetry install --all-extras
 
 .PHONY: clean
 clean: ## clean project
@@ -141,7 +141,7 @@ ui-test-%:
 	}
 	trap teardown EXIT
 	PORT="5005"
-	poetry run spotlight --host 127.0.0.1 --port $$PORT --no-browser . &
+	poetry run spotlight --host 127.0.0.1 --port $$PORT --no-browser  --folder . &
 	export BACKEND_BASE_URL="http://127.0.0.1:$${PORT}"
 	export FRONTEND_BASE_URL="http://127.0.0.1:$${PORT}"
 	wget -q -t20 -w0.5 --retry-connrefused --delete-after "$$BACKEND_BASE_URL"

README.md

@@ -140,7 +140,7 @@ Here, the data types are discovered automatically from the dataset and we use a
 
 #### Usage Tracking
 
-We have added crash report and perfomance collection. We do NOT collect user data other than an anonymized Machine Id obtained by py-machineid, and only log our own actions. We do NOT collect folder names, dataset names, or row data of any kind only aggregate performance statistics like total time of a table_load, crash data, etc. Collecting Spotlight crashes will help us improve stability. To opt out of the crash report collection define an environment variable called `SPOTLIGHT_OPT_OUT` and set it to true. e.G.`export SPOTLIGHT_OPT_OUT=true`
+We have added crash report and performance collection. We do NOT collect user data other than an anonymized Machine Id obtained by py-machineid, and only log our own actions. We do NOT collect folder names, dataset names, or row data of any kind only aggregate performance statistics like total time of a table_load, crash data, etc. Collecting Spotlight crashes will help us improve stability. To opt out of the crash report collection define an environment variable called `SPOTLIGHT_OPT_OUT` and set it to true. e.G.`export SPOTLIGHT_OPT_OUT=true`
 
 ## We are very happy to hear your feedback
 
@@ -153,3 +153,11 @@ We have added crash report and perfomance collection. We do NOT collect user dat
 - 🤗 [Huggingface](https://huggingface.co/renumics) example spaces and datasets 
 - 🏀 [Playbook](https://renumics.com/docs/playbook/) for data-centric AI workflows
 - 🍰 [Sliceguard](https://github.com/Renumics/sliceguard) library for automatic slice detection
+
+## Contribute
+
+We are currently participating in the running [Hacktoberfest 2023](https://hacktoberfest.com/).
+
+If you would like to contribute to Spotlight, the easiest way is to have a look at our [Contribution Docs](https://renumics.com/docs/development) and the [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+We are also equally happy about non-code contributions -- whether it's reporting bugs, suggesting features, contributing design ideas, or offering feedback, every non-code contribution is highly valued and helps make our project better for everyone.