diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6f71b0c..c090e2b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -95,7 +95,7 @@ jobs: - name: Checkout uses: actions/checkout@v2 - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: extension-artifacts @@ -128,7 +128,7 @@ jobs: - name: Checkout uses: actions/checkout@v2 - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: extension-artifacts @@ -156,7 +156,7 @@ jobs: - name: Checkout uses: actions/checkout@v2 - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: extension-artifacts @@ -182,7 +182,7 @@ jobs: - name: Checkout uses: actions/checkout@v2 - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: extension-artifacts diff --git a/docs/advanced.md b/docs/advanced.md index c7bfcef..54033c9 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -9,24 +9,21 @@ This section is mostly for reference and should not be needed for regular use of ### Provide a custom `empack_config.yaml` Packages sometimes ship more data than needed for the package to work (tests, documentation, data files etc). This is fine on a regular installation of the package, but in the emscripten case when running in the browser this means that starting the kernel would download more files. -For this reason, `empack` filters out anything that is not required for the Python code to run. It does it by following a set of filtering rules available in this file: https://github.com/emscripten-forge/empack/blob/main/config/empack_config.yaml. - -But this default filtering could break some packages. In that case you would probably want to either contribute to the default empack config, or provide your own set of filtering rules. +For this reason, `empack` allows filtering files that is are not required for the Python code to run. It does it by following a set of filtering rules available in this file: https://github.com/emscripten-forge/empack/blob/main/config/empack_config.yaml. The xeus-python kernel supports passing a custom `empack_config.yaml`. This file can be used to override the default filter rules set by the underlying `empack` tool used for packing the environment. -If you would like to provide additional rules for including or excluding files in the packed environment, create a `empack_config.yaml` with the following content as an example: +If you would like to provide additional rules for excluding files in the packed environment, create a `empack_config.yaml` with the following content as an example: ```yaml packages: xarray: - include_patterns: - - pattern: '**/*.py' + exclude_patterns: - pattern: '**/static/css/*.css' - pattern: '**/static/html/*.html' ``` -This example defines a set of custom rules for the `xarray` package to make sure it includes some static files that should be available from the kernel. +This example defines a set of custom rules for the `xarray` package to make sure it excludes some static files that are not required for the code to run. You can use this file when building JupyterLite: diff --git a/docs/build-environment.yml b/docs/build-environment.yml index 14dc74a..4e71fdf 100644 --- a/docs/build-environment.yml +++ b/docs/build-environment.yml @@ -14,7 +14,7 @@ dependencies: - myst-parser - pydata-sphinx-theme - jupyterlab >=4.0.5,<5 - - jupyterlite-core >=0.2,<0.4 + - jupyterlite-core >=0.2,<0.5 - jupyterlite-sphinx >=0.13.1 - empack >=3.1.0 - pip: diff --git a/pyproject.toml b/pyproject.toml index fa3c326..51c4ec8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,7 +23,7 @@ classifiers = [ "Programming Language :: Python :: 3.12", ] dependencies = [ - "empack>=3.1,<5", + "empack>=4.0.2,<5", "traitlets", "jupyterlite-core>=0.1,<0.5", "pyyaml",