fatiando / community

Community resources, guidelines, meeting notes, authorship policy, maintenance, etc.
Other
8 stars 4 forks source link

Stop distributing test files? #77

Open santisoler opened 1 year ago

santisoler commented 1 year ago

Description:

Currently most of our libraries hold their test functions along with the source code. Moreover, when we distribute the code (upload to PyPI or conda-forge) we are also providing this test functions and classes, along with the test data they need. This forces each user to download a bunch of files that they are not going to ever use (see https://github.com/fatiando/community/issues/44). Particularly Harmonica is seeing its test/data folder to growing a lot with sample grid files.

Would be better if we don't distribute the test folder inside the source code of our packages. This will lower the bandwidth and disk space required to install our packages without changing the user experience. If anyone wants to test the code, they will have to git clone the repo and run the tests, but this is how they should do so already.

Is there any reason why we would like to keep distributing those?

cc @leouieda

Apply to:

Further instructions:

We want your help!

We know that maintenance tasks are very demanding, so we don't expect a single person to tackle this issue by themselves. Any help is very welcomed, so please comment below that you want to take care of the changes on any repository and we will assign it to you.

leouieda commented 1 year ago

Packaging the tests lets us run the tests on the installed/packaged code like this: https://github.com/conda-forge/verde-feedstock/blob/main/recipe/meta.yaml#L39

But I'm not sure how useful that turns out to be.