[FR] External Data Support
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.9k
- Forks
- 1.4k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 1
Description
What's the problem this feature will solve?
Project Jupyter uses data_files for discovery of runtime extensions. This feature was deprecated without a viable alternative.
Describe the solution you'd like
The flit project recently added support for external_data, which is a simplified and constrained version of data_files. We could support an equivalent feature in setuptools, with caveats about when it is appropriate to use it.
Alternative Solutions
Project Jupyter and other current consumers of data_files could instead switch to using a flit backend, which we have been actively exploring.
Additional context
Project Jupyter uses data_files to allow libraries to provide shared setting and static assets files that are consumed by Jupyter at runtime. We have explored using entry_points for this purpose, but it did not scale well.
Code of Conduct
- I agree to follow the PSF Code of Conduct
Contributor guide
No contributing guide indexed for this repository
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 with the linked flit external_data documentation and setuptools' existing data_files behavior described in the issue. Define the supported scope and caveats, then establish what equivalent support in setuptools would require and how it should be validated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100