Add icechunk.print_debug_info() and Issue Templates (#753)

Author: ianhi

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,69 @@
+name: 🐛 Bug Report
+description: File a bug report to help us improve
+labels: [bug]
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: |
+        Thanks for reporting a bug! Please describe what you were trying to get done.
+        Tell us what happened, what went wrong.
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-did-you-expect-to-happen
+    attributes:
+      label: What did you expect to happen?
+      description: |
+        Describe what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    id: sample-code
+    attributes:
+      label: Minimal Complete Verifiable Example
+      description: |
+        Minimal, self-contained copy-pastable example that demonstrates the issue.         This will be automatically formatted into code, so no need for markdown backticks.
+      render: Python
+
+  - type: checkboxes
+    id: mvce-checkboxes
+    attributes:
+      label: MVCE confirmation
+      description: |
+        Please confirm that the bug report is in an excellent state, so we can understand & fix it quickly & efficiently. For more details, check out:
+
+        - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
+        - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports)
+
+      options:
+        - label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray.
+        - label: Complete example — the example is self-contained, including all data and the text of any traceback.
+        - label: Verifiable example — the example runs when copied & pasted into an fresh python environment.
+        - label: New issue — a search of GitHub Issues suggests this is not a duplicate.
+
+  - type: textarea
+    id: log-output
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
+      render: Python
+
+  - type: textarea
+    id: extra
+    attributes:
+      label: Anything else we need to know?
+      description: |
+        Please describe any other information you want to share.
+
+  - type: textarea
+    id: show-versions
+    attributes:
+      label: Environment
+      description: |
+        Paste the output of `icechunk.print_debug_info()`
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: True

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,29 @@
+---
+name: 📚 Documentation Issue/Suggestion
+about: Report parts probems with the docs or suggest improvments
+labels: documentation
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Problem
+
+<!--
+If you are referencing an existing piece of documentation or example please provide a link.
+
+* I found [...] to be unclear because [...]
+* [...] made me think that [...] when really it should be [...]
+* There is no example showing how to do [...]
+-->
+
+
+### Suggested Improvement
+
+<!--
+If you have an idea to improve the documentation please suggest it here
+
+* This line should be be changed to say [...]
+* Include a paragraph explaining [...]
+* Add a figure showing [...]
+-->

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,35 @@
+---
+name: Enhancement/Feature Request
+about: Suggest something that could be improved or a New Feature to add
+labels: enhancement
+---
+
+<!--
+Welcome! Thanks for thinking of a way to improve icechunk. If this solves a problem for you,
+then it probably solves that problem for lots of people! So the whole community will benefit from this request.
+
+
+Before creating a new feature request please search the issues for relevant feature requests.
+-->
+
+### Problem
+
+<!-- Provide a clear and concise description of what problem this feature will solve. For example:
+
+* I'm always frustrated when [...] because [...]
+* I would like it if [...] happened when I [...] because [...]
+-->
+
+### Proposed Solution
+
+<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
+
+* Add an option so that when [...]  [...] will happen
+ -->
+
+### Additional context
+
+<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
+
+* Another project [...] solved this by [...]
+-->

icechunk-python/python/icechunk/__init__.py

@@ -135,6 +135,7 @@
     "in_memory_storage",
     "initialize_logs",
     "local_filesystem_storage",
+    "print_debug_info",
     "s3_anonymous_credentials",
     "s3_credentials",
     "s3_from_env_credentials",
@@ -146,4 +147,19 @@
     "tigris_storage",
 ]
 
+
+def print_debug_info() -> None:
+    import platform
+    from importlib import import_module
+
+    print(f"platform:  {platform.platform()}")
+    print(f"python:  {platform.python_version()}")
+    print(f"icechunk:  {__version__}")
+    for package in ["zarr", "numcodecs", "xarray", "virtualizarr"]:
+        try:
+            print(f"{package}:  {import_module(package).__version__}")
+        except ModuleNotFoundError:
+            continue
+
+
 initialize_logs()

icechunk-python/tests/test_debuginfo.py

@@ -0,0 +1,6 @@
+from icechunk import print_debug_info
+
+
+def test_debug_info() -> None:
+    # simple test that this does not cause an error.
+    print_debug_info()