# gallery-dvk
*gallery-dvk* is a command-line program designed to download media from various media sharing websites: [See Supported Sites](./docs/supportedsites.md)
It is heavily inspired by [gallery-dl](https://github.com/mikf/gallery-dl), and if I were smart, I probably would have just forked gallery-dl, but I couldn't fully wrap my head around how the codebase works, so here we are. I may not be able to parse the code very well, but I've ripped off gallery-dl's user documentation pretty thoroughly here.
Contents:
+ [Installation](#installation)
+ [Usage](#usage)
+ [Configuration](#configuration)
+ [Authentication](#authentication)
## Installation
*gallery-dvk* can be downloaded from it's PyPI package using pip:
pip3 install gallery-dvk
If you are installing from source, the following python packages are required:
+ [beautifulsoup4](https://code.launchpad.net/beautifulsoup)
+ [HTML-String-Tools](https://github.com/Drakovek/HTML-String-Tools)
+ [Metadata-Magic](https://github.com/Drakovek/MetadataMagic)
+ [Python-Print-Tools](https://github.com/Drakovek/Python-Print-Tools)
+ [requests](https://requests.readthedocs.io/en/latest)
+ [tqdm](https://pypi.org/project/tqdm)
+ [pillow](https://github.com/python-pillow/Pillow) \(If using image stitching for Webtoon\)
## Usage
To use *gallery-dvk* call it with the URL you wish to download from:
gallery-dvk URL
You can also download a from a list of URLs from a text file:
gallery-dvk -i FILE
Use `gallery-dvk --help` for a full list of command-line options. You can access aditional options and configuration using a config file.
## Configuration
Configuration files for *gallery-dvk* are stored in JSON format.
### Documentation
Documentation for all the available configuration options can be found at [/docs/configuration.md](./docs/configuration.md)
A default config file can be found at [/docs/gallery-dvk.json](./docs/gallery-dvk.json)
A more in-depth example config file can be found at [/docs/gallery-dvk-example.json](./docs/gallery-dvk-example.json)
### Location
*gallery-dvk* looks for config files in the following locations:
**WINDOWS:**
+ `%APPDATA%\gallery-dvk\config.json`
+ `%USERPROFILE%\gallery-dvk\config.json`
+ `%USERPROFILE%\gallery-dvk.json`
(`%USERPROFILE%` usually refers to a user's home directory, i.e. C:\Users\<username>\)
**LINUX/MAC/UNIX-BASED:**
+ `/etc/gallery-dvk.json`
+ `${HOME}/.config/gallery-dvk/config.json`
+ `${HOME}/.gallery-dvk.json`
## Authentication
### Username and Password
Most extractors require login credentials to access some locked content, and some require login credentials to access the site at all.
You can set the necessary login information in your [configuration file](#configuration).
{
"transfur":
{
"username": "<USERNAME>",
"password": "<PASSWORD>"
}
}
Raw data
{
"_id": null,
"home_page": "https://github.com/Drakovek/gallery-dvk",
"name": "gallery-dvk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": null,
"author": "Drakovek",
"author_email": "DrakovekMail@gmail.com",
"download_url": null,
"platform": null,
"description": "# gallery-dvk\n\n*gallery-dvk* is a command-line program designed to download media from various media sharing websites: [See Supported Sites](./docs/supportedsites.md)\n\nIt is heavily inspired by [gallery-dl](https://github.com/mikf/gallery-dl), and if I were smart, I probably would have just forked gallery-dl, but I couldn't fully wrap my head around how the codebase works, so here we are. I may not be able to parse the code very well, but I've ripped off gallery-dl's user documentation pretty thoroughly here.\n\nContents:\n+ [Installation](#installation)\n+ [Usage](#usage)\n+ [Configuration](#configuration)\n+ [Authentication](#authentication)\n\n## Installation\n\n*gallery-dvk* can be downloaded from it's PyPI package using pip:\n\n pip3 install gallery-dvk\n\nIf you are installing from source, the following python packages are required:\n+ [beautifulsoup4](https://code.launchpad.net/beautifulsoup)\n+ [HTML-String-Tools](https://github.com/Drakovek/HTML-String-Tools)\n+ [Metadata-Magic](https://github.com/Drakovek/MetadataMagic)\n+ [Python-Print-Tools](https://github.com/Drakovek/Python-Print-Tools)\n+ [requests](https://requests.readthedocs.io/en/latest)\n+ [tqdm](https://pypi.org/project/tqdm)\n+ [pillow](https://github.com/python-pillow/Pillow) \\(If using image stitching for Webtoon\\)\n\n## Usage\n\nTo use *gallery-dvk* call it with the URL you wish to download from:\n\n gallery-dvk URL\n\nYou can also download a from a list of URLs from a text file:\n\n gallery-dvk -i FILE\n\nUse `gallery-dvk --help` for a full list of command-line options. You can access aditional options and configuration using a config file.\n\n## Configuration\n\nConfiguration files for *gallery-dvk* are stored in JSON format.\n\n### Documentation\n\nDocumentation for all the available configuration options can be found at [/docs/configuration.md](./docs/configuration.md)\n\nA default config file can be found at [/docs/gallery-dvk.json](./docs/gallery-dvk.json)\nA more in-depth example config file can be found at [/docs/gallery-dvk-example.json](./docs/gallery-dvk-example.json)\n\n### Location\n\n*gallery-dvk* looks for config files in the following locations:\n\n**WINDOWS:**\n+ `%APPDATA%\\gallery-dvk\\config.json`\n+ `%USERPROFILE%\\gallery-dvk\\config.json`\n+ `%USERPROFILE%\\gallery-dvk.json`\n\n(`%USERPROFILE%` usually refers to a user's home directory, i.e. C:\\Users\\<username>\\)\n\n**LINUX/MAC/UNIX-BASED:**\n+ `/etc/gallery-dvk.json`\n+ `${HOME}/.config/gallery-dvk/config.json`\n+ `${HOME}/.gallery-dvk.json`\n\n## Authentication\n\n### Username and Password\n\nMost extractors require login credentials to access some locked content, and some require login credentials to access the site at all.\n\nYou can set the necessary login information in your [configuration file](#configuration).\n\n {\n \"transfur\":\n {\n \"username\": \"<USERNAME>\",\n \"password\": \"<PASSWORD>\"\n }\n }\n",
"bugtrack_url": null,
"license": null,
"summary": "Utility for downloading media from various image hosting websites.",
"version": "0.4.2",
"project_urls": {
"Homepage": "https://github.com/Drakovek/gallery-dvk"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4e746f69a0e36f30810cf5e9c8b203ffd71e00ce065cfb4c6a487d00b8c78d99",
"md5": "1aa28c07c4f851e74fa904eb6c268897",
"sha256": "aa8fde496faea380e8818cee503ccaed3cf9c5f8a65b2c43d6139dc6b3860703"
},
"downloads": -1,
"filename": "gallery_dvk-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aa28c07c4f851e74fa904eb6c268897",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 76424,
"upload_time": "2025-03-14T03:24:12",
"upload_time_iso_8601": "2025-03-14T03:24:12.708823Z",
"url": "https://files.pythonhosted.org/packages/4e/74/6f69a0e36f30810cf5e9c8b203ffd71e00ce065cfb4c6a487d00b8c78d99/gallery_dvk-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-14 03:24:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Drakovek",
"github_project": "gallery-dvk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gallery-dvk"
}
JSON
