jhudsl / ottrpal

Tools for converting OTTR courses into Leanpub or Coursera courses :otter:
https://jhudatascience.org/ottrpal/
GNU General Public License v3.0
3 stars 1 forks source link

Refactoring ottrpal package #137

Open cansavvy opened 1 month ago

cansavvy commented 1 month ago

The ottrpal package has been left to decay and even started out as a bit of a hodgepodge.

I'd love to take a whack at reorganizing, restructuring and cleaning.

This would include tackling long standing issues like:

cansavvy commented 1 month ago

I think this is the order of operations for this:

  1. Determine essential functions for ottr
  2. Design and implement test-that tests for these functions
  3. Once tests are in place start the refactoring piece by piece (the unit tests will ensure or identify when we make breaking changes)
  4. Continue to refactor using this cycle of development
  5. Then create a release and send updates to CRAN and rebuild the docker image.
cansavvy commented 1 month ago

Should also pull the most useful parts of cow package and incorporate them

https://github.com/jhudsl/cow

I think mostly borrow_chapters get_pages_url are what we need

cansavvy commented 1 week ago

Writing some notes here:

https://docs.google.com/document/d/1KOzMc1dhfyc_oKV4RMZGl7CBVJ7EqxMWiAP4ktZiOxs/edit