KevinGG commented on pull request #11884:
URL: https://github.com/apache/beam/pull/11884#issuecomment-639670746


   > There's a lot of files there that don't seem relevant; I think we should 
go through and figure out what's needed for the actual plugin vs. what's 
"extras" that just got copied from a template. We also need to figure out the 
distribution story. Will this be released with beam? As another pypi pacakge 
(and npm package)?
   
   I can go through these files and explain their usages and the distribution 
story. If this is not enough, we can talk offline.
   
   [ESLint](https://eslint.org/docs/user-guide/getting-started)
   ```
   .eslintignore
   .eslintrc.js
   ```
   
   [Github 
workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)
   
   ```
   # This is later used in the README to display a status badge.
   .github/workflows/build.yml
   ```
   
   [Prettier](https://prettier.io/docs/en/install.html)
   
   ```
   .prettierignore
   .prettierrc.json
   ```
   
   [Python Packaging](https://packaging.python.org/guides/using-manifest-in/)
   
   ```
   MANIFEST.in
   ```
   
   JupyterLab server extension
   
   ```
   interactive_beam_side_panel/*.py
   ```
   
   
   JupyterLab frontend extension
   
   ```
   src/*.ts[x]
   ```
   
   JupyterLab frontend extension styles
   
   ```
   style/*.css
   ```
   
   JupyterLab configuration
   
   ```
   jupyter-config/*.json
   ```
   
   [TypeScript 
configuration](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)
   
   ```
   tsconfig.json
   ```
   
   [PEP 518](https://www.python.org/dev/peps/pep-0518/)
   
   ```
   pyproject.toml
   ```
   
   [npm 
package](https://nodejs.org/en/knowledge/getting-started/npm/what-is-the-file-package-json/)
   
   ```
   package.json
   ```
   
   The distribution story is 
[here](https://jupyterlab.readthedocs.io/en/stable/developer/extension_dev.html#shipping-packages).
   The plan is to ship the server extension (PYPI) and the frontend extension 
(NPM) separately.
   Temporarily, the server extension will just be a placeholder. We only need 
to release it once.
   The frontend extension can be shipped regularly: `The general idea is to 
pack the Jupyterlab extension using npm pack, and then use the data_files logic 
in setup.py to ensure the file ends up in the 
<jupyterlab_application>/share/jupyter/lab/extensions directory.`
   It doesn't have to be released with Beam releases.
   
   If this `sdks/python/apache_beam/runners/interactive` is not a suitable 
place to put the code base, we can move it to some other directory in this repo 
outside of `sdks`.
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to