ENH: list_engines function
Open
Nobody has claimed this yet.
contrib-good-first-issue
enhancement
needs discussion
topic-backends
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Is your feature request related to a problem?
It can be difficult to know what engines are available and where they come from. This could help with that.
Describe the solution you'd like
import xarray
xarray.list_engines()
Output:
Name | Description | Documentation
------------------------------------------------
rasterio | Open geospatial files (GeoTiff) | https://corteva.github.io/rioxarray
Describe alternatives you've considered
No response
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the engine discovery and registration entry point behind xarray.list_engines, then review how existing engines expose their names, descriptions, and documentation links. Done means the public function returns a listing with those fields and matches the requested example output; add or run the relevant tests once their location is identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100