README.md

   1 # thingy_grabber
   2 Script for archiving thingiverse things. Due to this being a glorified webscraper, it's going to be very fragile.
   3
   4 ## Usage:
   5 `thingy_grabber.py [-v] user_name collection_name`
   6
   7 Where `user_name` is the name of the creator of the collection (not nes. your name!) and `collection_name` is the name of the collection you want.
   8
   9 This will create a series of directorys `user-collection/thing-name` for each thing in the collection.
  10
  11 If for some reason a download fails, it will get moved sideways to `thing-name-failed` - this way if you rerun it, it will only reattmpt any failed things.
  12
  13 ## Requirements
  14 python3, beautifulsoup4, requests, lxml
  15
  16 ## Current features:
  17 - can download an entire collection, creating seperate subdirs for each thing in the collection
  18 - If you run it again with the same settings, it will check for updated files and only update what has changed. This should make it suitible for syncing a collection on a cronjob
  19 CAVEAT: This script will *not delete files*. So if there has been an update and some files have been moved or renamed, they will be mixed in with the old stuff.
  20
  21
  22 ## Todo features (maybe):
  23 - download a single thing
  24 - download things by designer
  25 - less perfunctory error checking / handling
  26 - attempt to use -failed dirs for resuming
  27 - pull down images as well
  28 - handle old/deleted files on update