Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: wiki and changelog updates for v6.1.0 release #416

Merged
merged 13 commits into from
Jan 4, 2025
43 changes: 42 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,48 @@ 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-06

### Fixed

- Incorrect pre-conditions check for v5 to v6 database transfer
- 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**

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 16 additions & 3 deletions docs/transition-to-v6.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
Expand All @@ -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 known version with v4 support: `6.1.0`
NTFSvolume marked this conversation as resolved.
Show resolved Hide resolved

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</a>

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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading