lincc-frameworks / lincc-frameworks/python-project-template

Investigate ways to support data

Open
#443 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Jinja
Stars
85
Forks
16
Avg merge
6h 18m
Merged PRs (30d)
1

Description

There are few places where data really becomes important. Tests, notebooks, and generally for the package.

We've seen many instances where a package requires a large amount of data to run. But it's impractical to include that data in the distribution. We've come up a few specific ways to address that, but let's consider if there's a way that we can include a best practice approach in the template as well.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how the template currently handles tests, notebooks, and package data, then assess the data-management approaches under consideration. Done means selecting and documenting a best-practice approach that can be included in the template.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.