todo list for version 4.0

[NickleDave]

making an issue that's the to-do list for version 4.0 that tracks what issues to close, and puts them roughly in some order

• rewrite API plan for new API / interface #120
• add formats bass class add a Format abstract base class / interface #105
• write annotations as attrs classes represent annotation formats as attrs classes #99
  • refactor existing formats in process
    • refactor generic-seq format, use pandas refactor 'generic-seq' format; use pandas for generating csv #63
    • have PHN annotation format have logic for converting on/offset_inds -> seconds #154
    • ENH: make it so simple-seq can parse various formats #134
• add formats sub-package add formats sub-package? #109
• change how annotation formats are listed change how annotation formats are listed #92
  • would be good to have a convenient way to list the string names. crowsetta.formats.names?
• refactor Transcriber class refactor Transcriber class #144
• remove entry points remove entry points #94
• clean up Annotation class(es)
  • rename Annotation.audio_path attribute to notated_path rename Annotation.audio_path attribute to notated_path #148
  • why is seq attribute on Annotation optional? why is seq attribute on Annotation optional? #149
  • separate Annotation classes for SeqLike and BboxLike? should we have separate SeqLikeAnnotation and BboxLikeAnnotation classes? #150
• rename sequence/segment attributes 'on/offset_ind' to 'on/offset_sample'? #156
• decide if we want to use register_format decorator fix register_format decorator #119
• remove Stack class for now remove Stack class -- unused #170
• remove 'csv' format (alias) DEP: actually remove the 'csv' format for version 4.0 #171
• add example annotation files to package add example annotation files to package #90
• rewrite docs rewrite docs #152
  • DOC: use TIMIT README when writing documentation for 'phn' format #157
  • DOC/TST: add examples to all docstrings, using built-in data  #158
• add logo add logo #17
• DOC: add images of spectrograms with annotation, use example data for this #21

[NickleDave]

Closed by 737a50c