build: Provide no-op handler for non-insiders contributors

.copier-answers.yml

@@ -0,0 +1,23 @@
+# Changes here will be overwritten by Copier
+_commit: 1.0.0
+_src_path: gh:mkdocstrings/handler-template
+author_email: [email protected]
+author_fullname: Timothée Mazzucotelli
+author_username: pawamoy
+copyright_date: '2023'
+copyright_holder: Timothée Mazzucotelli
+copyright_holder_email: [email protected]
+copyright_license: ISC License
+insiders: true
+insiders_email: [email protected]
+insiders_repository_name: mkdocstrings-shell
+language: Shell
+project_description: A shell scripts/libraries handler for mkdocstrings.
+project_name: mkdocstrings-shell
+public_release: false
+python_package_distribution_name: mkdocstrings-shell
+python_package_import_name: shell
+repository_name: shell
+repository_namespace: mkdocstrings
+repository_provider: github.com
+

.envrc

@@ -0,0 +1 @@
+PATH_add scripts

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+github: pawamoy
+ko_fi: pawamoy
+polar: pawamoy
+custom:
+- https://www.paypal.me/pawamoy

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,61 @@
+---
+name: Bug report
+about: Create a bug report to help us improve.
+title: "bug: "
+labels: unconfirmed
+assignees: [pawamoy]
+---
+
+### Description of the bug
+<!-- Please provide a clear and concise description of what the bug is. -->
+
+### To Reproduce
+<!-- Please provide a Minimal Reproducible Example (MRE) if possible.
+     Try to boil down the problem to a few lines of code.
+     Your code should run by simply copying and pasting it.
+
+     Example:
+
+     ```
+     git clone https://github.com/username/repro
+     cd repro
+     python -m venv .venv
+     . .venv/bin/activate
+     pip install -r requirements.txt
+     ...  # command or code showing the issue
+     ```
+-->
+
+```
+WRITE MRE / INSTRUCTIONS HERE
+```
+
+### Full traceback
+<!-- Please provide the full error message / traceback if any, by pasting it in the code block below.
+     No screenshots! -->
+
+<details><summary>Full traceback</summary>
+
+```python
+PASTE TRACEBACK HERE
+```
+
+</details>
+
+### Expected behavior
+<!-- Please provide a clear and concise description of what you expected to happen. -->
+
+### Environment information
+<!-- Please run the following command in your repository and paste its output below it,
+     redacting sensitive information. -->
+
+```bash
+python -m mkdocstrings_handlers.shell.debug  # | xclip -selection clipboard
+```
+
+PASTE OUTPUT HERE
+
+### Additional context
+<!-- Add any other relevant context about the problem here,
+     like links to other issues or pull requests, screenshots, etc.
+-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+- name: I have a question / I need help
+  url: https://github.com/mkdocstrings/shell/discussions/new?category=q-a
+  about: Ask and answer questions in the Discussions tab.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+title: "feature: "
+labels: feature
+assignees: pawamoy
+---
+
+### Is your feature request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. -->
+
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.github/workflows/ci.yml

@@ -0,0 +1,114 @@
+name: ci
+
+on:
+  push:
+  pull_request:
+    branches:
+    - main
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  LANG: en_US.utf-8
+  LC_ALL: en_US.utf-8
+  PYTHONIOENCODING: UTF-8
+  PYTHON_VERSIONS: ""
+
+jobs:
+
+  quality:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Fetch all tags
+      run: git fetch --depth=1 --tags
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install uv
+      run: pip install uv
+
+    - name: Install dependencies
+      run: make setup
+
+    - name: Check if the documentation builds correctly
+      run: make check-docs
+
+    - name: Check the code quality
+      run: make check-quality
+
+    - name: Check if the code is correctly typed
+      run: make check-types
+
+    - name: Check for vulnerabilities in dependencies
+      run: make check-dependencies
+
+    - name: Check for breaking changes in the API
+      run: make check-api
+
+  exclude-test-jobs:
+    runs-on: ubuntu-latest
+    outputs:
+      jobs: ${{ steps.exclude-jobs.outputs.jobs }}
+    steps:
+    - id: exclude-jobs
+      run: |
+        if ${{ github.repository_owner == 'pawamoy-insiders' }}; then
+          echo 'jobs=[
+            {"os": "macos-latest"},
+            {"os": "windows-latest"},
+            {"python-version": "3.9"},
+            {"python-version": "3.10"},
+            {"python-version": "3.11"},
+            {"python-version": "3.12"}
+          ]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
+        else
+          echo 'jobs=[]' >> $GITHUB_OUTPUT
+        fi
+
+  tests:
+
+    needs: exclude-test-jobs
+    strategy:
+      matrix:
+        os:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+        python-version:
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.python-version == '3.12' }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+
+    - name: Install uv
+      run: pip install uv
+
+    - name: Install dependencies
+      run: make setup
+
+    - name: Run the test suite
+      run: make test

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: release
+
+on: push
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Fetch all tags
+      run: git fetch --depth=1 --tags
+    - name: Setup Python
+      uses: actions/setup-python@v4
+    - name: Install build
+      if: github.repository_owner == 'pawamoy-insiders'
+      run: python -m pip install build
+    - name: Build dists
+      if: github.repository_owner == 'pawamoy-insiders'
+      run: python -m build
+    - name: Upload dists artifact
+      uses: actions/upload-artifact@v4
+      if: github.repository_owner == 'pawamoy-insiders'
+      with:
+        name: shell-insiders
+        path: ./dist/*
+    - name: Install git-changelog
+      if: github.repository_owner != 'pawamoy-insiders'
+      run: pip install git-changelog
+    - name: Prepare release notes
+      if: github.repository_owner != 'pawamoy-insiders'
+      run: git-changelog --release-notes > release-notes.md
+    - name: Create release with assets
+      uses: softprops/action-gh-release@v1
+      if: github.repository_owner == 'pawamoy-insiders'
+      with:
+        files: ./dist/*
+    - name: Create release
+      uses: softprops/action-gh-release@v1
+      if: github.repository_owner != 'pawamoy-insiders'
+      with:
+        body_path: release-notes.md

.gitignore

@@ -0,0 +1,24 @@
+# editors
+.idea/
+.vscode/
+
+# python
+*.egg-info/
+*.py[cod]
+.venv/
+.venvs/
+/build/
+/dist/
+
+# tools
+.coverage*
+/.pdm-build/
+/htmlcov/
+/site/
+
+# cache
+.cache/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+__pycache__/

.gitpod.dockerfile

@@ -0,0 +1,6 @@
+FROM gitpod/workspace-full
+USER gitpod
+ENV PIP_USER=no
+RUN pip3 install pipx; \
+    pipx install uv; \
+    pipx ensurepath

.gitpod.yml

@@ -0,0 +1,13 @@
+vscode:
+  extensions:
+  - ms-python.python
+
+image:
+  file: .gitpod.dockerfile
+
+ports:
+- port: 8000
+  onOpen: notify
+
+tasks:
+- init: make setup

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+<!-- insertion marker -->