Merge pull request #1 from jupyterlite/bootstrap

Bootstrap the repo from the cookiecutter
jupyterlite · Dec 2, 2022 · 704384e · 704384e
2 parents e515bc0 c7afba6
commit 704384e
Show file tree

Hide file tree

Showing 25 changed files with 6,582 additions and 2 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0  1,7 @@
 node_modules
 dist
 coverage
 **/*.d.ts
 tests
 
 **/__tests__
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0  1,39 @@
 module.exports = {
   extends: [
     'eslint:recommended',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:prettier/recommended'
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     project: 'tsconfig.json',
     sourceType: 'module'
   },
   plugins: ['@typescript-eslint'],
   rules: {
     '@typescript-eslint/naming-convention': [
       'error',
       {
         selector: 'interface',
         format: ['PascalCase'],
         custom: {
           regex: '^I[A-Z]',
           match: true
         }
       }
     ],
     '@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/quotes': [
       'error',
       'single',
       { avoidEscape: true, allowTemplateLiterals: false }
     ],
     curly: ['error', 'all'],
     eqeqeq: 'error',
     'prefer-arrow-callback': 'error'
   }
 };
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0  1,84 @@
 name: Build
 
 on:
   push:
     branches: main
   pull_request:
     branches: '*'
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout
       uses: actions/checkout@v2
 
     - name: Base Setup
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
     - name: Install dependencies
       run: python -m pip install -U jupyterlab~=3.1
 
     - name: Lint the extension
       run: |
         set -eux
         jlpm
         jlpm run eslint:check
         python -m pip install .
         jlpm run lint:check
 
     - name: Build the extension
       run: |
         set -eux
         python -m pip install .
         jupyter labextension list
         jupyter labextension list 2>&1 | grep -ie "@jupyterlite/pyodide-kernel.*OK"
 
         # TODO: add JupyterLite browser check
         # python -m jupyterlab.browser_check
 
     - name: Package the extension
       run: |
         set -eux
 
         pip install build
         python -m build
         pip uninstall -y "jupyterlite_pyodide_kernel" jupyterlab
 
     - name: Upload extension packages
       uses: actions/upload-artifact@v2
       with:
         name: extension-artifacts
         path: dist/jupyterlite_pyodide_kernel*
         if-no-files-found: error
 
   test_isolated:
     needs: build
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout
       uses: actions/checkout@v2
     - name: Install Python
       uses: actions/setup-python@v2
       with:
         python-version: '3.9'
         architecture: 'x64'
     - uses: actions/download-artifact@v2
       with:
         name: extension-artifacts
     - name: Install and Test
       run: |
         set -eux
         # Remove NodeJS, twice to take care of system and locally installed node versions.
         sudo rm -rf $(which node)
         sudo rm -rf $(which node)
 
         pip install "jupyterlab~=3.1" jupyterlite_pyodide_kernel*.whl
 
         jupyter labextension list
         jupyter labextension list 2>&1 | grep -ie "@jupyterlite/pyodide-kernel.*OK"
 
         # TODO: add JupyterLite browser check
         # python -m jupyterlab.browser_check --no-chrome-test
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -0,0  1,29 @@
 name: Check Release
 on:
   push:
     branches: ["main"]
   pull_request:
     branches: ["*"]
 
 jobs:
   check_release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Base Setup
         uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install Dependencies
         run: |
           pip install -e .
       - name: Check Release
         uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
         with:
 
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Upload Distributions
         uses: actions/upload-artifact@v2
         with:
           name: jupyterlite_pyodide_kernel-releaser-dist-${{ github.run_number }}
           path: .jupyter_releaser_checkout/dist
diff --git a/.github/workflows/enforce-labels.yml b/.github/workflows/enforce-labels.yml
@@ -0,0  1,13 @@
 name: Enforce PR label
 
 on:
   pull_request:
     types: [labeled, unlabeled, opened, edited, synchronize]
 jobs:
   enforce-label:
     runs-on: ubuntu-latest
     permissions:
       pull-requests: write
     steps:
       - name: enforce-triage-label
         uses: jupyterlab/maintainer-tools/.github/actions/enforce-label@v1
diff --git a/.gitignore b/.gitignore
@@ -0,0  1,115 @@
 *.bundle.*
 lib/
 node_modules/
 .eslintcache
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
 jupyterlite_pyodide_kernel/labextension
 # Version file is handled by hatchling
 jupyterlite_pyodide_kernel/_version.py
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
 
 ### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
 # C extensions
 *.so
 
 # Distribution / packaging
 .Python
 build/
 develop-eggs/
 dist/
 downloads/
 eggs/
 .eggs/
 lib/
 lib64/
 parts/
 sdist/
 var/
 wheels/
 pip-wheel-metadata/
 share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
 
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
 .tox/
 .nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
 .pytest_cache/
 
 # Translations
 *.mo
 *.pot
 
 # Scrapy stuff:
 .scrapy
 
 # Sphinx documentation
 docs/_build/
 
 # PyBuilder
 target/
 
 # pyenv
 .python-version
 
 # celery beat schedule file
 celerybeat-schedule
 
 # SageMath parsed files
 *.sage.py
 
 # Spyder project settings
 .spyderproject
 .spyproject
 
 # Rope project settings
 .ropeproject
 
 # Mr Developer
 .mr.developer.cfg
 .project
 .pydevproject
 
 # mkdocs documentation
 /site
 
 # mypy
 .mypy_cache/
 .dmypy.json
 dmypy.json
 
 # Pyre type checker
 .pyre/
 
 # End of https://www.gitignore.io/api/python
 
 # OSX files
 .DS_Store
diff --git a/.prettierignore b/.prettierignore
@@ -0,0  1,5 @@
 node_modules
 **/node_modules
 **/lib
 **/package.json
 jupyterlite_pyodide_kernel
diff --git a/.prettierrc b/.prettierrc
@@ -0,0  1,6 @@
 {
   "singleQuote": true,
   "trailingComma": "none",
   "arrowParens": "avoid",
   "endOfLine": "auto"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0  1,5 @@
 # Changelog
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
 <!-- <END NEW CHANGELOG ENTRY> -->
diff --git a/LICENSE b/LICENSE
@@ -0,0  1,29 @@
 BSD 3-Clause License
 
 Copyright (c) 2022, JupyterLite Contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 
 3. Neither the name of the copyright holder nor the names of its
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.