[Question] Using gallery-dl in a script, with options?

[dunnousername]

First of all, I really appreciate all of the contributors who work on this project. It's genuinely a wonderful piece of software and I wish more people would know about it.

I'm trying to make a Python script that can download something with either youtube_dl or gallery-dl, taking as input the URL and output filename/directory.

I found DownloadJob, but besides the URL to download I can't really figure out how to hand it options (like output filename/directory). How do I do that? If possible, I'd also like to get all of the available metadata, but I think I could do using DataJob.

Thanks!

[mikf]

Options can only be set globally at the moment, although you can still have different settings for different sites. To set options you have to manipulate the _config dict in config.py in place, which should be done through config.set():

from gallery_dl import config

# setting for imgur
config.set(("extractor", "imgur"), "filename", "{id}.{extension}")

# setting for all modules
config.set((), "filename", "{id}.{extension}")

To set a concrete output path, you should manipulate the base-directory and filename settings, and set directory to an empty string or list.

config.set((), "directory", "")

config.set((), "base-directory", "...")  # set output directory
config.set((), "filename"      , "...")  # set output filename format

If possible, I'd also like to get all of the available metadata, but I think I could do using DataJob.

Derive a new class from DataJob that defines its own handle_url() etc. There you can get the metadata dict as kwdict argument, and call the base classes methods to have the regular "download" functionality.

[dunnousername]

That was very informative, thanks! I just figured out "base-directory" but I didn't know about the other config vars, so the folder structure was still really long. I also didn't think about making a new DataJob subclass, I was instead trying to read the JSON file it generated. This will work much nicer now. Thank you for the help!