Add timestamp support
[clinton/thingy_grabber.git] / README.md
CommitLineData
4f6e317c 1# thingy_grabber
975060c9
OM
2Script for archiving thingiverse things. Due to this being a glorified webscraper, it's going to be very fragile.
3
4## Usage:
e36c2a07 5`thingy_grabber.py [-v] user_name collection_name`
a7152c35 6
975060c9
OM
7Where `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
a7152c35 9This will create a series of directorys `user-collection/thing-name` for each thing in the collection.
a7152c35
OM
10
11If 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
975060c9 13## Requirements
c4388960 14python3, beautifulsoup4, requests, lxml
975060c9
OM
15
16## Current features:
17- can download an entire collection, creating seperate subdirs for each thing in the collection
e36c2a07
OM
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
19CAVEAT: 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.
975060c9 20
e36c2a07
OM
21
22## Todo features (maybe):
975060c9
OM
23- download a single thing
24- download things by designer
25- less perfunctory error checking / handling
a7152c35 26- attempt to use -failed dirs for resuming
e36c2a07
OM
27- pull down images as well
28- handle old/deleted files on update