brainglobe / cellfinder-core

Standalone cellfinder cell detection algorithm
https://brainglobe.info/documentation/cellfinder/index.html
BSD 3-Clause "New" or "Revised" License
19 stars 16 forks source link

MANIFEST only necessary files for package install #195

Closed willGraham01 closed 1 year ago

willGraham01 commented 1 year ago

Description

What is this PR

Why is this PR needed?

We currently ship the benchmarks and tests with the source distribution. We shouldn't do this.

What does this PR do?

References

How has this PR been tested?

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

alessandrofelder commented 1 year ago

LGTM!

For the record, some thinking and discussion with @lauraporta that went into this.

I had second thoughts about removing the tests from the package and read an online discussion (key excerpts below)

My (personal) view is that I want the sdist so that I can build the project on an otherwise-unsupported environment, and I can view the source code of the project (even though pure Python wheels include the source, it’s not in “buildable form”).

and

If the project is non-trivial, you probably need to run the tests to ensure that your build is functional, no?

but given our tests are useless with the the biggish test data in our repo, and we really don't want to ship the test data, let's remove them entirely. Users that want to run the tests on a source install can always clone and install from the repo 🤷