burr
burr copied to clipboard
General naming consistencies -- fix + document + ensure best practices moving forward:
Is your feature request related to a problem? Please describe. Too early in the library to have these -- we need to keep backwards compatibility but want to make it consistent/easy to reason about.
Specifically:
a_<plugin>versusplugin(done to distinctify async)- When should/should these ever live together?
- Should we have a separate
aiopackage? (oraorasync(which isn't allowed)
b_<plugin>versus- Some have these and some don't (
integrations.b_aiosqlite, etc...) - Confusing with
a_(aimplies async,bimpliesburr,a_bimplies async Burr I suppose?) - Done initially to disambiguate import names, although not consistently
- Some have these and some don't (
plugin-> package extension name configuration- No clear mapping here
- Makes it really hard to understand what needs to be installed
- Maybe we have live checks -- should probably consistently be using this tool
Describe the solution you'd like
- Come up with best practices
- Document/ensure them, make any migrations needed
- Figure out how to keep it consistent in the future (open-ended)
Describe alternatives you've considered Chaos :)
Additional context Add any other context or screenshots about the feature request here.