Improve README and Documentation

[KyleKing]

Review these articles for useful information:

• Logging
  • Logging levels: the wrong abstraction | IG Labs
  • Log Levels
  • What should you log in an application and how to avoid having 24×7 support looking
    at them?
  • Logging from tryceratops
• How to fix a bug
• Add list of advice of regular function over class
• Regex Tips
  • regex visualization
• Testing
  • stubbing-vs-mocking
  • Testing the diff - Vinta Blog
• Code Review Steps
• For calcipy_template: https://github.com/TezRomacH/python-package-template/tree/184e6cd577106753f0129d8341803b0e7b425404#readme
• README Checklist
  • https://tldp.org/HOWTO/Software-Release-Practice-HOWTO/distpractice.html#readme
• For README, see:
  • https://github.com/matiassingers/awesome-readme
  • https://www.makeareadme.com/
  • https://github.com/othneildrew/Best-README-Template
• "One of the Team" https://python-hyper.org/en/latest/one-of-the-team.html
• PR Guidelines: https://gist.github.com/mherrmann/5ce21814789152c17abd91c0b3eaadca
• And this good guide on development: https://geo-python.github.io/2017/lessons/L6/debugging-scripts.html
• And this on code review (for Go, but still applicable): https://github.com/golang/go/wiki/CodeReviewComments
• And testing style guides: https://blog.thea.codes/my-python-testing-style-guide/
• For Github practices
  • https://petabridge.com/blog/use-github-professionally/
  • and for labels, see https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63 (use Type: *, etc. // git-labelmaker is no longer maintained)
• On Code: https://hub.codebeat.co/docs/software-quality-metrics
• And Style: https://docs.python-guide.org/writing/style/
• element-meta/wiki/triage-process
  • Talk on out of control review processes
• debugging-series-2021-welcome-to-the-jungle
• Every Programmer Should Know