[SN-0] Switched notebooks to RYE for better management cleaned up everything (#1619)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: Gabefire

.github/workflows/notebooks.yml

@@ -1,4 +1,4 @@
-name: Labelbox Python SDK Notebooks (Develop)
+name: Labelbox Example Notebook Workflow
 
 on:
   push:
@@ -13,25 +13,72 @@ on:
 permissions:
   contents: write
   pull-requests: write
-  
+
 jobs:
-  update:
+  # Get installs from rye and run rye run clean to format
+  format:
+    if: github.event.pull_request.merged == false
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
           fetch-depth: 0
-      - name: Install databooks
-        run: pip install databooks
-      - name: Remove notebook metadata
-        run: echo "y" | databooks meta examples/. --rm-outs
+      - uses: ./.github/actions/python-package-shared-setup
+        with:
+          rye-version: ${{ vars.RYE_VERSION }}
+          python-version: 3.12
+      - name: Format
+        working-directory: examples
+        run: rye run clean
+      - name: Commit changes
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add examples/.
+          git commit -m ":art: Cleaned" || exit 0
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.head_ref }}
+  # See if notebooks were added or deleted (name change counts as both)
+  changes:
+    needs: format
+    if: github.event.pull_request.merged == false
+    runs-on: ubuntu-latest
+    outputs:
+      addedOrModified: ${{ steps.filter.outputs.addedOrModified }}
+    steps:
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            addedOrModified:
+              - added|deleted: 'examples/**/*.ipynb'
+  # Create readme if the above job shows true using rye run create-readme
+  create:
+    needs: changes
+    if: ${{ needs.changes.outputs.addedOrModified == 'true' }} && github.event.pull_request.merged == false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+      - uses: ./.github/actions/python-package-shared-setup
+        with:
+          rye-version: ${{ vars.RYE_VERSION }}
+          python-version: 3.12
+      - name: Create readme
+        working-directory: examples
+        run: rye run create-readme
       - name: Commit changes
         run: |
-            git config --local user.email "github-actions[bot]@users.noreply.github.com"
-            git config --local user.name "github-actions[bot]"
-            git add examples/.
-            git commit -m "Removed metadata" || exit 0
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add examples/.
+          git commit -m ":memo: README updated" || exit 0
       - name: Push changes
         uses: ad-m/github-push-action@master
         with:

.github/workflows/rdme-custompages.yml

@@ -0,0 +1,27 @@
+name: ReadMe GitHub Action 🦉
+
+on:
+  pull_request:
+    branches: [develop]
+    types:
+      - closed
+    paths:
+      - examples/README.md
+
+jobs:
+  custompages:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/python-package-shared-setup
+        with:
+          rye-version: ${{ vars.RYE_VERSION }}
+          python-version: 3.12
+      - name: Create readme
+        working-directory: examples
+        run: rye run create-doc-readme
+      - name: Run `custompages` command
+        uses: readmeio/rdme@v8
+        with:
+          rdme: custompages examples/tutorials.html --key=${{ secrets.README_API_KEY }}

examples/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contribution Guide
+
+Thank you for contributing to our notebook examples! To ensure that your contribution aligns with our guidelines, please carefully review the following guide.
+
+## Table of Contents
+
+- [General Notebook Requirements](#general-notebook-requirements)
+- [Branches and Tags](#branches-and-tags)
+- [Github Workflows](#github-workflows)
+- [General Prerequisites](#general-prerequisites)
+- [Styling Tools](#styling-tools)
+
+## General Notebook Requirements
+
+Review our [template notebook](template.ipynbs) for general overview on how notebooks should be structure. This notebook and section just serves as a guide and exceptions can be made. Here are our general requirements:
+
+1. Ensure that any modified notebooks run when edited.
+2. Ensure that you update any relevant headers and comments within the code block you may add or change.
+3. Notebooks should start with a top header below the Labelbox and link icons with the title of the notebook as a main header **#** and a overview of what the notebook shows.
+4. Use "labelbox[data]" over labelbox for installs to ensure you have the correct dependencies.
+5. Imports and installs should come after the main header under a **Setup** section.
+6. Labelbox and other platforms with clients and API keys should be specified under a single section.
+7. Subsections need a second level header **##** and an overview of the section.
+8. The last cell should be a clean up section to delete any labelbox objects created and commented out to prevent accidentally running code blocks.
+9. Notebook github action [workflows](#github-workflows) are required to run successfully before merging.
+
+> [!IMPORTANT]
+> Please make sure to remove any API keys before pushing changes
+
+## Branches and Tags
+
+- All development happens in feature branches ideally prefixed by contributor's initials. For example `fs/feature_name`.
+- Approved PRs are merged to the `develop` branch.
+- All releases align to a git tag.
+
+## Github Workflows
+
+- Github Branch Workflow
+  - When you push to a branch that contains files inside the examples directory, it will automatically reformat your notebook to match our given style and provide appropriate headers. Once this workflow is completed it will commit back to your branch which then you can pull.
+  - If your push contains new notebooks or modifies the names of notebooks the readme will be updated to reflect the change with updated links.
+
+## General Prerequisites
+
+[Rye](https://rye-up.com/) may be installed before contributing to the repository as it is the tool used to style our example notebooks. This could be used to avoid the github styling workflow. This is also the packaging tool used for the main SDK. The pyproject used for the example notebooks is a virtual package and does not get published.
+
+## Styling Tools
+
+Rye is setup in this directory to use a customs script that will run the notebooks through our formatting tools and create readmes.
+
+- `rye sync` in the examples folder to install the correct dev dependencies.
+- `rye run clean` runs a series of formatting tools.
+- `rye run create-readme` creates a readme based off our notebooks.