From eeb027ba8ba98a37172c635d9734412f36a42a89 Mon Sep 17 00:00:00 2001 From: NTFSvolume <172021377+NTFSvolume@users.noreply.github.com> Date: Sat, 4 Jan 2025 17:30:14 -0500 Subject: [PATCH] docs: wiki and changelog updates for v6.1.0 release (#416) * docs: update changelog * docs: add ruff badge * chore: bump version to v6.1.0 * docs: add ruff hyperlink * docs: fix README padding * docs: update CLI overview (wiki) * docs: add v4 deprecation disclaimer * docs: update 6.0.0 hyperlink * docs: update changelog * docs: fix typo * docs: update v4 import disclaimer Co-authored-by: Jacob * docs: remove db fix from changelog Move to the next release --------- Co-authored-by: Jacob --- CHANGELOG.md | 42 ++++++++++++++++++++++++++++++++- README.md | 1 + docs/reference/cli-arguments.md | 1 + docs/transition-to-v6.md | 19 ++++++++++++--- pyproject.toml | 2 +- 5 files changed, 60 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f77b8469..a0ce2634 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,47 @@ All notable changes to this project will be documented here. For more details, v The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [6.0.0] - 2024-12-20 + +## [6.1.0] - 2025-01-05 + +### Fixed + +- Fallback to old file password check (cyberfile) +- Handle stream redirects (bunkr) +- Files being saved with the current date instead of the upload date +- Sanitize filenames before downloading +- Apprise notifications integration +- Log startup errors to a file (validation, YAML, database and unknown errors) +- Miscalculation of download and scrape queue length +- Sorting videos with invalid or missing fps metadata +- e-Hentai crawler + +### Changed + +- Set 512MB as the minimum required free space +- `--console-log-level` will have no effect unless `--no-ui` was used +- OS notification are enabled by default on Windows + +### Deprecated + +- `--output-folder` is deprecated. Use `--download-folder` +- v4 support (importing v4 config and files) will be removed in a future version + +### Added + +- `--deep-scrape` option: https://script-ware.gitbook.io/cyberdrop-dl/reference/configuration-options/settings/runtime_options#deep_scrape +- `--separate-posts-format` option: https://script-ware.gitbook.io/cyberdrop-dl/reference/configuration-options/settings/download_options#separate_posts_format +- Allow any file name for cookie files +- Redact username from log tracebacks + + +## [6.0.1] - 2024-12-24 + +### Fixed + +- Database v5 to v6 transfer + +## [6.0.0] - 2024-12-23 ⚠️**BREAKING CHANGES** diff --git a/README.md b/README.md index 0ec966bd..932426d4 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cyberdrop-dl-patched)](https://pypi.org/project/cyberdrop-dl-patched/) [![Docs](https://img.shields.io/badge/docs-wiki-blue?link=https%3A%2F%2Fscript-ware.gitbook.io%2Fcyberdrop-dl)](https://script-ware.gitbook.io/cyberdrop-dl) [![GitHub License](https://img.shields.io/github/license/jbsparrow/CyberDropDownloader)](https://github.com/jbsparrow/CyberDropDownloader/blob/master/LICENSE) +[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/jbsparrow/CyberDropDownloader/actions/workflows/ruff.yaml) [![PyPI - Downloads](https://img.shields.io/pypi/dm/cyberdrop-dl-patched)](https://pypistats.org/packages/cyberdrop-dl-patched) [![Discord](https://discordapp.com/api/guilds/1070206871564197908/widget.png?style=banner2)](https://discord.com/invite/P5nsbKErwy) diff --git a/docs/reference/cli-arguments.md b/docs/reference/cli-arguments.md index bec476fa..8d8098ec 100644 --- a/docs/reference/cli-arguments.md +++ b/docs/reference/cli-arguments.md @@ -227,6 +227,7 @@ runtime_options: --jdownloader-download-dir JDOWNLOADER_DOWNLOAD_DIR --jdownloader-autostart, --no-jdownloader-autostart --jdownloader-whitelist [JDOWNLOADER_WHITELIST ...] + --deep-scrape, --no-deep-scrape sorting: --sort-downloads, --no-sort-downloads diff --git a/docs/transition-to-v6.md b/docs/transition-to-v6.md index dbd43c7c..1d625310 100644 --- a/docs/transition-to-v6.md +++ b/docs/transition-to-v6.md @@ -21,7 +21,7 @@ V6 introduces some breaking changes: Using a more strict config validation logic It's recommended to do a manual backup of your current `AppData` folder. You won't be able to rollback to a previous version after the transfer is completed. -You can learn more about these changes on the [release announcement](https://github.com/jbsparrow/CyberDropDownloader/blob/master/CHANGELOG.md#600---2024-12-20) +You can learn more about these changes on the [release announcement](https://github.com/jbsparrow/CyberDropDownloader/blob/master/CHANGELOG.md#600---2024-12-23) {% endhint %} {% hint style="warning" %} @@ -40,11 +40,24 @@ If the migration fails, the database will be rolled back to its previous state. ## Import V4 config to V6 -Built into Cyberdrop-DL V6 is a tool that allows you to import both your configs and your history DB from a v4 version of Cyberdrop-DL. +{% hint style="warning" %} +Support for v4 is deprecated and will be removed in a future release. To upgrade to the latest version, you may need to perform a sequential upgrade. First, update CDL to the last version that supported v4 and then update to the latest version. + +Last version with v4 support: `6.1.0` + +You can install an specific version with pip by running: + +```shell +pip install cyberdrop-dl-patched==VERSION +``` + +{% endhint %} + +Built into Cyberdrop-DL is a tool that allows you to import both your configs and your history DB from a v4 version of Cyberdrop-DL. You can use it by selecting "Import V4 Items". ### Importing previous configs -This is pretty straight forward. The config will be located in the folder that you were previously running Cyberdrop-DL in. +The config will be located in the folder that you were previously running Cyberdrop-DL in. {% hint style="info" %} If you weren't using the config previously, you don't need to import it. diff --git a/pyproject.toml b/pyproject.toml index fe13ab95..b213dece 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ include = ["CHANGELOG.md"] packages = [{include = "cyberdrop_dl"}] readme = "README.md" repository = "https://github.com/jbsparrow/CyberDropDownloader" -version = "6.0.1" +version = "6.1.0" [tool.poetry.dependencies] python = ">=3.11,<3.14"