README.md

   1 # WIP: yt-mango 💾
   2
   3 > YT metadata extractor inspired by [`youtube-ma` by _CorentinB_][youtube-ma]
   4
   5 __Warning: Very WIP!__ Only `channel dumpurls` and `video detail` work rn
   6
   7 ##### Build
   8
   9 Install and compile the Go project with `go get github.com/terorie/yt-mango`!
  10
  11 If you don't have a Go toolchain, grab an executable from the Releases tab
  12
  13 ##### Project structure
  14
  15 - _/data_: Data definitions
  16 - _/api_: Abstract API definitions
  17     - _/apiclassic_: HTML API implementation (parsing using [goquery][goquery])
  18     - _/apijson_: JSON API implementation (parsing using [fastjson][fastjson])
  19 - _/net_: HTTP utilities (asnyc HTTP implementation)
  20 - _/cmd_: Cobra CLI
  21 - _/util_: I don't have a better place for these
  22
  23 - _/pretty_: (not yet used) Terminal color utilities
  24 - _/controller_: (not yet implemented) worker management
  25     - _/db_: (not yet implemented) MongoDB connection
  26     - _???_: (not yet implemented) Redis queue
  27
  28  [youtube-ma]: https://github.com/CorentinB/youtube-ma
  29  [goquery]: https://github.com/PuerkitoBio/goquery
  30  [fastjson]: https://github.com/valyala/fastjson
  31  [cobra]: https://github.com/spf13/cobra