feat: Cookiecutter template (#449)

Adds a templates directory as well as an inital bidirectional widget
plugin.
Can test with the following command
```
cookiecutter gh:deephaven/deephaven-plugins --directory="templates/widget" 
```

.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+# templates cannot be properly checked for formatting due to the substitution syntax
+exclude: templates
 repos:
   - repo: https://github.com/adamchainz/blacken-docs
     rev: 1.15.0

templates/README.md

@@ -0,0 +1,22 @@
+# Deephaven Plugin Templates
+
+This repository contains templates for creating Deephaven plugins.
+In order to use these templates, you must have [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) installed.
+
+There are two main ways to use these templates.
+If you have this repository locally, you can run the following command from where you want to create your plugin:
+```sh
+cookiecutter <path/to/deephaven-plugins>/templates/<template name>
+```
+
+If you don't have this repository locally, you can run the following command:
+```sh
+cookiecutter gh:deephaven/deephaven-plugins --directory="templates/<template name>"
+```
+
+Currently, we offer the following templates:
+
+## widget
+
+This creates a basic bidirectional widget plugin for Deephaven.
+A bidirectional plugin can send and receive messages on both the client and server.

templates/widget/cookiecutter.json

@@ -0,0 +1,22 @@
+{
+  "python_project_name": "deephaven_plugin_template",
+  "javascript_project_name": "{{ cookiecutter.python_project_name.lower().replace('_', '-') }}",
+  "author_name": "Anonymous",
+  "author_email": "Anonymous",
+  "__py_namespace": "{{ cookiecutter.python_project_name }}",
+  "__src_folder_name": "{{ cookiecutter.python_project_name }}",
+  "__name_pascal_case": "{{ cookiecutter.python_project_name.replace('_', ' ') .title().replace(' ', '') }}",
+  "__registered_object_name": "{{ cookiecutter.__name_pascal_case }}",
+  "__object_name": "{{ cookiecutter.__name_pascal_case }}Object",
+  "__object_file_name": "{{ cookiecutter.python_project_name }}_object",
+  "__type_name": "{{ cookiecutter.__name_pascal_case }}Type",
+  "__type_file_name": "{{ cookiecutter.python_project_name }}_type",
+  "__message_stream_name": "{{ cookiecutter.__name_pascal_case }}MessageStream",
+  "__py_js_plugin_obj_name": "{{ cookiecutter.__name_pascal_case }}JsPlugin",
+  "__registration_name": "{{ cookiecutter.__name_pascal_case }}Registration",
+  "__js_plugin_name_pascal_case": "{{ cookiecutter.javascript_project_name.replace('-', ' ') .title().replace(' ', '') }}",
+  "__js_plugin_view_class": "{{ cookiecutter.javascript_project_name }}-view",
+  "__js_plugin_view_obj": "{{ cookiecutter.__js_plugin_name_pascal_case }}View",
+  "__js_plugin_view_obj_style": "{{ cookiecutter.__js_plugin_view_obj }}Style",
+  "__js_plugin_obj": "{{ cookiecutter.__js_plugin_name_pascal_case }}Plugin"
+}

templates/widget/hooks/pre_gen_project.py

@@ -0,0 +1,6 @@
+import sys
+
+python_project_name = '{{ cookiecutter.python_project_name }}'
+
+if not python_project_name.isidentifier():
+    raise ValueError(f'{python_project_name} is not a valid Python project name')

templates/widget/{{ cookiecutter.python_project_name }}/.gitignore

@@ -0,0 +1,8 @@
+build/
+dist/
+.venv/
+/venv
+*.egg-info/
+.idea
+.DS_store
+__pycache__/

templates/widget/{{ cookiecutter.python_project_name }}/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

templates/widget/{{ cookiecutter.python_project_name }}/README.md

@@ -0,0 +1,121 @@
+# {{ cookiecutter.python_project_name }}
+
+This is a Python plugin for Deephaven generated from a [deephaven-plugin](https://github.com/deephaven/deephaven-plugins) template.
+
+Specifically, this plugin is a bidirectional widget plugin, which can send and receive messages on both the client and server.
+The plugin works out of the box, demonstrates basic plugin structure, and can be used as a starting point for building more complex plugins.
+
+## Plugin Structure
+
+The `src` directory contains the Python and JavaScript code for the plugin.
+Within the `src` directory, the {{ cookiecutter.python_project_name }} directory contains the Python code, and the `js` directory contains the JavaScript code.
+
+The Python files have the following structure:
+`{{ cookiecutter.__object_file_name }}.py` defines a simple Python class that can send messages to the client.
+`{{ cookiecutter.__type_file_name }}.py` defines the Python type for the plugin (which is used for registration) and a simple message stream.
+`js_plugin.py` defines the Python class that will be used to setup the JavaScript side of the plugin.
+`register.py` registers the plugin with Deephaven.
+
+The JavaScript files have the following structure:
+`{{ cookiecutter.__js_plugin_obj }}.ts` registers the plugin with Deephaven.
+`{{ cookiecutter.__js_plugin_view_obj }}.tsx` defines the plugin panel and message handling.
+
+Additionally, the `test` directory contains Python tests for the plugin. This demonstrates how the embedded Deephaven server can be used in tests.
+It's recommended to use `tox` to run the tests, and the `tox.ini` file is included in the project.
+
+## Building the Plugin
+
+To build the plugin, you will need `npm` and `python` installed, as well as the `build` package for Python.
+`nvm` is also strongly recommended, and an `.nvmrc` file is included in the project.
+The python venv can be created and the recommended packages installed with the following commands:
+```sh
+cd {{ cookiecutter.python_project_name }}
+python -m venv .venv
+source .venv/bin/activate
+pip install --upgrade -r requirements.txt
+```
+
+Build the JavaScript plugin from the `src/js` directory:
+
+```sh
+cd src/js
+nvm install
+npm install
+npm run build
+```
+
+Then, build the Python plugin from the top-level directory:
+
+```sh
+cd ../..
+python -m build --wheel
+```
+
+The built wheel file will be located in the `dist` directory.
+
+## Installing the Plugin
+
+The plugin can be installed into a Deephaven instance with `pip install <wheel file>`.
+The wheel file is stored in the `dist` directory after building the plugin.
+Exactly how this is done will depend on how you are running Deephaven.
+If using the venv created above, the plugin and server can be created with the following commands:
+```sh
+pip install deephaven-server
+pip install dist/{{ cookiecutter.python_project_name }}-0.0.1.dev0-py3-none-any.whl
+deephaven server
+```
+See the [plug-in documentation](https://deephaven.io/core/docs/how-to-guides/use-plugins/) for more information.
+
+## Using the Plugin
+
+Once the Deephaven server is running, the plugin should be available to use.
+
+```python
+from {{ cookiecutter.python_project_name }} import {{ cookiecutter.__object_name }}
+
+obj = {{ cookiecutter.__object_name }}()
+```
+
+A panel should appear. You can now use the object to send messages to the client.
+
+```python
+obj.send_message("Hello, world!")
+```
+
+The panel can also send messages back to the Python client by using the input field.
+
+## Distributing the Plugin
+To distribute the plugin, you can upload the wheel file to a package repository, such as [PyPI](https://pypi.org/).
+The version of the plugin can be updated in the `setup.cfg` file.
+
+There is a separate instance of PyPI for testing purposes.
+Start by creating an account at [TestPyPI](https://test.pypi.org/account/register/).
+Then, get an API token from [account management](https://test.pypi.org/manage/account/#api-tokens), setting the “Scope” to “Entire account”.
+
+To upload to the test instance, use the following commands:
+```sh
+python -m pip install --upgrade twine
+python -m twine upload --repository testpypi dist/*
+```
+
+Now, you can install the plugin from the test instance. The extra index is needed to find dependencies:
+```sh
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ {{ cookiecutter.python_project_name }}
+```
+
+For a production release, create an account at [PyPI](https://pypi.org/account/register/).
+Then, get an API token from [account management](https://pypi.org/manage/account/#api-tokens), setting the “Scope” to “Entire account”.
+
+To upload to the production instance, use the following commands. 
+Note that `--repository` is the production instance by default, so it can be omitted:
+```sh
+python -m pip install --upgrade twine
+python -m twine upload dist/*
+```
+
+Now, you can install the plugin from the production instance:
+```sh
+pip install {{ cookiecutter.python_project_name }}
+```
+
+See the [Python packaging documentation](https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives) for more information.

templates/widget/{{ cookiecutter.python_project_name }}/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=43.0.0", "wheel", "deephaven-plugin-packaging"]
+build-backend = "setuptools.build_meta"