Feat/pluggable docs update

.bumpversion.cfg

@@ -0,0 +1,12 @@
+[bumpversion]
+current_version = 0.6.3
+commit = True
+tag = True
+
+[bumpversion:file:pyproject.toml]
+
+[bumpversion:file:package.json]
+
+[bumpversion:file:buckaroo/_version.py]
+
+[bumpversion:file:docs/source/conf.py]

.coveragerc

@@ -1,2 +1,2 @@
 [run]
-omit = dcf/tests/*
+omit = buckaroo/tests/*

.eslintignore

@@ -2,4 +2,6 @@ node_modules
 dist
 coverage
 **/*.d.ts
-tests
+tests
+js/vendor/RechartTooltip.tsx
+js/baked_data/colorMap.ts

.eslintrc.js

@@ -7,15 +7,24 @@ module.exports = {
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: 'tsconfig.eslint.json',
+    project: "tsconfig.json",
     sourceType: 'module'
   },
-  plugins: ['@typescript-eslint'],
+    plugins: ['@typescript-eslint',
+	      'prettier'
+	     ],
   rules: {
     '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-namespace': 'off',
     '@typescript-eslint/no-use-before-define': 'off',
+    "@typescript-eslint/no-unused-vars": "off",
+
+    //necessary for js/version.ts... otherwise the python build fails
+    "@typescript-eslint/no-var-requires": "off",
+
+
+    "@typescript-eslint/explicit-function-return-type": "off",
     '@typescript-eslint/quotes': [
       'error',
       'single',
@@ -24,5 +33,9 @@ module.exports = {
     curly: ['error', 'all'],
     eqeqeq: 'error',
     'prefer-arrow-callback': 'error'
-  }
-};
+  },
+    "ignorePatterns": [
+        "webpack.config.ts",
+        "jest.config.js"
+    ]
+};

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,88 @@
+name: '🐞 Bug report - Python'
+description: Report an issue with Buckaroo.
+labels: [bug]
+
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checks
+      options:
+        - label: >
+            I have checked that this issue has not already been reported.
+          required: true
+        - label: >
+            I have confirmed this bug exists on the
+            [latest version](https://github.com/paddymul/buckaroo) of Buckaroo.
+          required: true
+
+  - type: dropdown
+    id: Notebook-system
+    attributes:
+      label: What type of jupyter notebook were you using (VSCode notebook, google colab, Jupyter Lab, Jupyter notebook).  Select multiple if you can reproduce this in multiple environments.  If other, please add to description.
+      multiple: true
+      options:
+        - VS Code
+        - Jupyter Lab
+        - Google Colab
+        - Jupyter Notebook
+        - Other (please describe in Issue Description)
+    validations:
+      required: true
+
+  - type: textarea
+    id: example
+    attributes:
+      label: Reproducible example
+      description: >
+        Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
+        provide a minimal, copy-pastable example. [Infinity displays as blank](https://github.com/paddymul/buckaroo/issues/122) is an excellent buckaroo example. Include the (wrong) output if applicable.
+      value: |
+        ```python
+
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Issue description
+      description: >
+        Provide any additional information you think might be relevant. If this is a visual bug, provide a screenshot of the input dataframe and the top couple of lines of buckaroo output.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: >
+        Describe or show a code example of the expected behavior.
+    validations:
+      required: true
+
+  - type: textarea
+    id: version
+    attributes:
+      label: Installed versions
+      description: >
+        Paste the output of ``buckaroo.debug_packages()``
+      value: |
+        <details>
+        ```
+        Replace this line with the output of buckaroo.debug_packages(). Leave the backticks in place.
+        ```
+        </details>
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Jupyter Log output
+      description: >
+        If the buckaroo widget completely didn't display, check the Jupyter Log Console.  Also check the javascript console of the browser to see if any obvious JS errors occurred.  This is optional
+        Paste the output of the logs  here.
+      render: shell
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false    

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,58 @@
+name: 'Enhancement Request'
+description: Request an enhancement to Buckaroo.
+labels: [enhancement]
+
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checks
+      options:
+        - label: >
+            I have checked that this enhancement has not already been requested
+          required: true
+
+  - type: dropdown
+    id: Subsystem
+    attributes:
+      label: How would you categorize this request.  You can select multiple if not sure
+      multiple: true
+      options:
+        - Display (is this related to visual display of a value)
+        - Documentation
+        - Summary stats
+        - Developer ergonomics (defaults, error messages)
+        - Auto Cleaning
+        - Performance
+        - Developer Experience/CI (feature to make it easier to devlop on Buckaroo)
+        - Low Code UI
+        - Other (please describe in Issue Description)
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Enhancement Description
+      description: >
+        How would you like Buckaroo to function?  Write a description of what you want buckaroo to do.
+    validations:
+      required: true
+
+  - type: textarea
+    id: pseudo-code-implementation
+    attributes:
+      label: Pseudo Code Implementation
+      description: >
+        If applicable, write simple python code that shows an input dataframe, the code to transform it to the output dataframe you are looking for, and the output dataframe.
+    validations:
+      required: false
+
+  - type: textarea
+    id: prior-art
+    attributes:
+      label: Prior Art
+      description: >
+        Link to other tools that function in the way you want.  Describe how that tool solves this problem. Videos are welcome too
+    validations:
+      required: true

.github/workflows/build.yml

@@ -12,33 +12,85 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.7", "3.10"]
+        #os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest]
+        python-version: ["3.9"]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-
+        uses: actions/checkout@v4
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          cache: yarn
 
       - name: Install dependencies
         run: |
           python -m pip install -U codecov
           npm install -g codecov
+
+      - name: Check docs can be build + links
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        working-directory: docs
+        run: |
+          sudo apt install -y pandoc graphviz
+          pip install sphinx==7.1.2 pytest-check-links graphviz==0.20.1
+          make html
+          python -m pytest --check-links
+
       - name: Test the extension
         run: |
           python -m pip install --upgrade -v -e ".[test, examples, docs]"
-          python -m pytest
+          python -m pytest tests/unit
           yarn run test
 
       - name: Linting
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           yarn run lint:check
+          pip install ruff
+          ruff check . 
 
-      - name: Check docs can be build + links
-        if: ${{ matrix.os == 'ubuntu-latest' }}
-        working-directory: docs
+      - name: Package
         run: |
-          sudo apt install -y pandoc
-          make html
-          python -m pytest --check-links
+          python -m pip install build
+          python -m build .
+
+      - name: Upload builds
+        uses: actions/upload-artifact@v4
+        with:
+          name: buckaroo-dist-${{ github.run_number }}
+          path: |
+            ./dist
+            ./js/*.tgz
+
+
+  ui-test:
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: buckaroo-dist-${{ github.run_number }}
+
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Setup buckaroo ui test
+        run: pip install `echo dist/*.whl`[ui-test] -r requirements-ui-test.txt
+
+      - name: Install playwright browsers
+        run: playwright install chromium
+
+      - name: Run ui-tests
+        run: SOLARA_TEST_RUNNERS=jupyter_lab pytest tests/ui/ --video=retain-on-failure
+
+      - name: Upload Test artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: buckaroo-test-results-${{ github.run_number }}
+          path: test-results

.gitignore

@@ -156,5 +156,9 @@ myproject/labextension
 
 ipydatagrid/labextension/*
 ipydatagrid/nbextension/*
-dcf/nbextension/*
-dcf/labextension/*
+buckaroo/nbextension/*
+buckaroo/labextension/*
+docs/*.js
+docs/*.js.map
+docs/*js*
+docs/source/_static/*woff*

.readthedocs.yaml

@@ -0,0 +1,24 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    nodejs: "20"
+  apt_packages:
+    - graphviz
+    - npm
+    - git
+  jobs:
+    post_build:
+      - echo "Command run at 'post_build' step"
+      - echo `date`
+      - echo "$READTHEDOCS_OUTPUT/html"
+      - pwd
+      - git rev-parse HEAD
+      - node --version
+      - npm install -g yarn@1.22.19
+      - yarn --version
+      - yarn install
+      - yarn run build:examples
+      - cp -r docs/build/html/examples "$READTHEDOCS_OUTPUT/html"