feat: add print_debug_info function

[ianhi]

Created the print_debug_info function from #2907
Will render in the issue template like this:

example output:

platform: macOS-15.3-arm64-arm-64bit-Mach-O
python: 3.13.2

zarr: 3.0.5.dev8+g71a77687.d20250308

numcodecs: 0.15.1
numpy: 2.2.3
fsspec: 2025.3.0

closes #2907

• Add unit tests and/or doctests in docstrings
• Add docstrings and API docs for any new/modified user-facing classes and functions
• [NA?] New/modified features documented in docs/user-guide/*.rst
• Changes documented as a new file in changes/
• GitHub Actions have all passed
• Test coverage is 100% (Codecov passes)

[jhamman]

Thanks @ianhi - I like the concept here. Just a few suggestions to make it a bit more complete.

[jhamman]

to make this test a bit more meaningful, let's capture the output and assert that it matches our basic expectations. https://docs.pytest.org/en/stable/how-to/capture-stdout-stderr.html#accessing-captured-output-from-a-test-function

[ianhi]

I tested two outputs that should always be there. I didn't test every output because at some point that just becomes rewriting the fucntion

[jhamman]

can we include the full list of required and optional dependencies here?

Required dependencies: donfig | numcodecs | numpy | packaging | typing-extensions
Optional dependencies: botocore | cupy-cuda12x | fsspec| numcodecs | rich | s3fs | universal-pathlib | obstore

[ianhi]

I added all of them. They're in a list because introspecting the package to grab it's own dependencies seemed to add a bit of unnecessary complication

[ianhi]

After discussino with @jhamman there is a sequencing issue here. If we change the issue template prior to releasing the function it won't be possible to make an issue! So I think the way forward is to merge the function and then added the issue template chagnes later

[dstansby]

Very nice! I left some minor suggestions to improve the formatting which I think are worth considering, but feel free to take them or leave them.

[dstansby]

Suggested change

	print("Optional dependencies:")
	print("Optional dependencies")
	print("---------------------")

[ianhi]

The trouble with this is that it can render as a pagebreak in github markdown and turns the text above into an H2 text which I find a bit confusing for the flow of the isssue

How does using asterisks feel to you?

[dstansby]

Ah, I didn't think about the "putting this into markdown on GitHub stage" 🤦 . In that case either asterisks or no change is fine by me 👍

[d-v-b]

@jhamman do you still want changes, or is this good to go?

[dstansby]

There's been lots of time to review, so I'm going to merge. Improvements to exactly what's printed can definitely be made in future micro releases, so I think this is low risk to merge now.

Review comments addressed