🚧🚀🚇♻️ Shape up for release

[s-weigand]

This PR brings the package in shape for its first release (0.5.0rc1).

None:
Not to break user code the change for plot functions to return fig, axes needs to be done in 3 steps:
1.) Add argument figure_only=True (current behavior) and warn the user to change it (part of this PR)
2.) In 0.7.0 replace figure_only=True, with **kwargs and warn the user

if "figure_only" in kwargs:

3.) In 0.9.0 remove **kwargs again.

This way users can gradually upgrade and get instructions on how to change the code w/o having broken code.

Change summary

• 🧹🩹 Only include pyglotaran_extras folder itself to setup package lookup
• 🚇 Added integration tests
• ✨ Added basic deprecation functionality
• ♻️ Renamed 'boilerplate' -> 'setup_case_study' and export load_data from io
• ♻️👌 Reexport overview plot functions from plotting package
• 🚇👌 Use new 'install_extras: false' option in integration test workflow
• ♻️ Renamed 'plotting.data' -> 'plotting.plot_data'
• 👌 Improved typing
• 👌 Added 'figsize' argument to all functions which create figures
• 🧹 Added cycler arg to plot functions so users have more control over the style
• 🧹 Changed package version to '0.5.0rc1'
• 🗑️ First step deprecation of plot functions only returning the Figure
• 👌 Export commonly used functions from package top level
• ⬆️🔧 Update pre-commit config

Checklist

• ✔️ Passing the tests (mandatory for all PR's)
• 👌 Closes issue (mandatory for ✨ feature and 🩹 bug fix PR's)
• 🧪 Adds new tests for the feature (mandatory for ✨ feature and 🩹 bug fix PR's)

Closes issues

closes #17
closes #18
closes #20
closes #21

[github-actions]

👈 Launch a binder notebook on branch s-weigand/pyglotaran-extras/shape-up-for-release

[codecov]

Codecov Report

Merging #40 (c0d7120) into main (2964f2a) will increase coverage by 36.43%.
The diff coverage is 54.40%.

@@            Coverage Diff             @@
##            main      #40       +/-   ##
==========================================
+ Coverage   4.26%   40.70%   +36.43%     
==========================================
  Files         17       22        +5     
  Lines        516      597       +81     
  Branches      70       77        +7     
==========================================
+ Hits          22      243      +221     
+ Misses       494      354      -140     

Impacted Files	Coverage Δ
pyglotaran_extras/plotting/plot_concentrations.py	41.66% <0.00%> (+41.66%)	⬆️
pyglotaran_extras/plotting/plot_doas.py	0.00% <0.00%> (ø)
pyglotaran_extras/plotting/plot_traces.py	31.81% <ø> (+31.81%)	⬆️
tests/io/test_setup_case_study.py	0.00% <0.00%> (ø)
pyglotaran_extras/plotting/plot_overview.py	27.27% <13.79%> (+27.27%)	⬆️
pyglotaran_extras/plotting/plot_data.py	33.33% <33.33%> (ø)
pyglotaran_extras/plotting/plot_svd.py	20.00% <45.45%> (+20.00%)	⬆️
pyglotaran_extras/plotting/plot_spectra.py	21.95% <66.66%> (+21.95%)	⬆️
pyglotaran_extras/plotting/plot_residual.py	27.77% <80.00%> (+27.77%)	⬆️
pyglotaran_extras/__init__.py	100.00% <100.00%> (ø)
... and 18 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2964f2a...c0d7120. Read the comment docs.

[jsnel]

LGTM! 🎉