From 3c2b9afc13dcc4596c501bff5cb91ad0a46d28f1 Mon Sep 17 00:00:00 2001 From: Lightling Date: Fri, 9 Feb 2024 23:03:22 -0500 Subject: [PATCH] docs --- LICENSE.md | 9 +++++++++ README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..72fad9f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2024 Lightling + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c3dec4 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# gallery-dl-archive-manager + +Scripts to manage a (currently twitter only) archive using gallery-dl. Much of the code came from a need to augment pre-existing, outdated archives that were originally created from the `twittermediadownloader` browser extension. + +## Config +This repo uses its own `config.json` in order to save media in the same format as `twittermediadownloader`. The scripts depend on the media being saved in this format. + +## Scripts + +### `node run-initDb.js --path={/path/to/your/archive} --args={gallery-dl args}` + +Initializes a user database from existing folders. Useful if you have a pre-existing archive of users. + +### `node run-downloadDb.js --path={/path/to/your/archive} --threads={#} --args={gallery-dl args}` + +## Args + +Standard args: + +### `--path={/path/to/your/archive}` + +The path to the archive. This is a parent directory with a list of child directories which correspond to users. + +### `--threads={#}` + +Max number of concurrent download threads. Only this number of concurrent gallery-dl download threads will run at a given time, other remaining users will be queued. + +### `--args={gallery-dl args}` + +Additional args to pass to gallery-dl. Note that these aren't currently checked for duplicates that may be used by this repo. + +## TODO + +### `run-addUsers.js --path={/path/to/your/archive} --users={string array of user(s)} --threads={#}` + +Should add a new user to the db and initiate a full download similar to `run-downloadDb.js` + +### `run-updateDb.js --path={/path/to/your/archive} --mode={search|media} --threads={#} --args={gallery-dl args}` + +Should pull from the user database and update the archive without doing a full download. + +- `--mode` + - `=search`: The DB should save with a lastUpdated field. This should be used as a date for the /search API. Preferred if it's been a long time since an update has happened for a user and/or the user has uploaded a significant amount of media since lastUpdated. + - `=media`: This will run /media and stop after hitting skipped files, as skipped files indicate hitting lastUpdated. Preferred in normal circumstances.