Privatize internal conda-store API

conda-incubator / conda-store

Data science environments, for collaboration. ✨

https://conda.store

BSD 3-Clause "New" or "Revised" License

137 stars 44 forks source link

Privatize internal conda-store API #820

Closed peytondmurray closed 1 week ago

peytondmurray commented 1 month ago

Closes #723.

Description

This PR privatizes most of conda-store and conda-store-server in preparation for implementing an upcoming backwards compatibility policy.

This pull request:

Moves everything into _internal subpackages, except for a select few outward-facing APIs.

Pull request checklist

[x] Did you test this change locally?
[x] Did you update the documentation (if required)?
[x] Did you add/update relevant tests for this change (if required)?

Additional information

How to test

No special testing requirements because new behavior has not been introduced; standard CI tests are sufficient.

netlify[bot] commented 1 month ago

Deploy Preview for conda-store canceled.

Name	Link
Latest commit	561881ef2ba4cc87391598256df34d58ab2c4ede
Latest deploy log	https://app.netlify.com/sites/conda-store/deploys/6673289a6081190008a78f19

pavithraes commented 3 weeks ago

@peytondmurray Thanks for the PR.

Moves everything into _internal subpackages, except for a select few outward-facing APIs.

Verified this, and looks good to me. :)

From a design POV, would it make sense to actually move some configuration options (example configs, Nebari's conda-store config) out of _internal? If end-users need to set these config values to deploy conda-store, I'd expect these to be served by our compatibility policy.

peytondmurray commented 3 weeks ago

100%, you're right. I'll move anything that contains subclasses of LoggingConfigurable back out so that they're exposed to the user.