[2023] Compatibility with pandas 2.0, and Read the Docs

[amotl]

Maintenance

• Add compatibility with pandas 2.0. It has been released recently. ¹
• Remove compatibility details with Python 2.

Documentation

• Give the code examples more love. Outline a snippet within the README, and add them to the test suite. This improves educating people how to use phenodata as a library, see Using phenodata as a library #3.
• Add configuration to publish the documentation to Read the Docs.
• Add CITATION.cff file. ²³
• Significantly rework README, and improve documentation across the board.
• Make the "forecast" feature less prominent, because it offers only a naive approach.
• Add proselint.

Footnotes

1. https://phofl.github.io/pandas-20.html ↩

2. https://the-turing-way.netlify.app/communication/citable/citable-cff.html ↩

3. https://citation-file-format.github.io/ ↩

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.61 🎉

Comparison is base (0696811) 89.68% compared to head (fdbdc14) 90.30%.

❗ Current head fdbdc14 differs from pull request most recent head 0dbb411. Consider uploading reports for the commit 0dbb411 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #18      +/-   ##
==========================================
+ Coverage   89.68%   90.30%   +0.61%     
==========================================
  Files           6        8       +2     
  Lines         601      629      +28     
==========================================
+ Hits          539      568      +29     
+ Misses         62       61       -1     

Flag	Coverage Δ
unittests	90.30% <100.00%> (+0.61%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
phenodata/command.py	80.80% <ø> (ø)
examples/observations.py	100.00% <100.00%> (ø)
examples/stations.py	100.00% <100.00%> (ø)
phenodata/dwd/cdc.py	92.00% <100.00%> (-0.16%)	⬇️
phenodata/dwd/pheno.py	91.69% <100.00%> (+0.36%)	⬆️
phenodata/ftp.py	91.80% <100.00%> (-0.07%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.