Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move resources folder #7

Open
3 tasks
trevorb1 opened this issue Dec 19, 2022 · 0 comments
Open
3 tasks

Move resources folder #7

trevorb1 opened this issue Dec 19, 2022 · 0 comments

Comments

@trevorb1
Copy link
Member

There is currently a src/resources/ folder that holds datasets for the processing scripts. However, I don't think this is the place to keep them. Two main reason I can think of for this is:

  • When/if the project is moved to be an installable package via pip, this resources/ folder will not be captured in the install. We can of course move it under the installed files, however, I feel this should be reserved for code (just my opinion though and I think this is up for discussion)
  • If people clone the repository, they will be downloading all the data in this folder. If its just a few small csvs its no big deal. But this can quickly get out of hand if all of us start adding datasets to this folder.

This issue is likely part of the bigger question of "where to store our data"? However, I would consider this a successful PR if:

  • Datasets are moved out of the resources/ folder
  • Scripts will only download the required datasets for their functionality
  • Scripts will check if data have already been locally downloaded first, and only download when required (probably a utility function)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant