diff --git a/README.md b/README.md index 975f340..c7a414f 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,15 @@ Run the script and follow prompts or use CLI arguments with command `qbt_migrate -t {Windows,Linux,Mac}, --target-os {Windows,Linux,Mac} Target OS (converts slashes). Default will auto-detect if conversion is needed based on existing vs new. -b BT_BACKUP_PATH, --bt-backup-path BT_BACKUP_PATH - BT_Backup Path Override. + BT_backup Path Override. -s, --skip-bad-files Skips bad .fastresume files instead of exiting. Default behavior is to exit. -l {DEBUG,INFO}, --log-level {DEBUG,INFO} Log Level, Default is INFO. -By default, everything happens in the BT_Backup directory defined by the OS the script is running on. +By default, everything happens in the BT_backup directory defined by the OS the script is running on. Override `BT_backup` path if needed. -Default BT_Backup paths: +Default BT_backup paths: * Windows: `%LOCALAPPDATA%/qBittorrent/BT_backup` * Linux/Mac: `$HOME/.local/share/data/qBittorrent/BT_backup` @@ -59,25 +59,25 @@ The correct pattern for this would be `-e X: -n /torrents` or `-e X:\ -n /torren #### Docker You can also run this tool with Docker if you don't have Python, or don't want to install the package to your system directly. -The BT_Backup path is automatically overridden to `/tmp/BT_Backup`, so mount your `BT_Backup` there. +The BT_backup path is automatically overridden to `/tmp/BT_backup`, so mount your `BT_backup` there. **NOTE:** When running `qbt_migrate` Docker image on a Linux/Mac machine, Windows paths will require double `\`. Ex. `C:\\Users\\user\\Downloads\\Torrents` **The Docker image has all functionality as the pip install, following the same arguments/patterns listed in the above examples.** -For example, mounting in the default BT_Backup path on a Windows machine running Docker +For example, mounting in the default BT_backup path on a Windows machine running Docker docker run -v %LOCALAPPDATA%/qBittorrent/BT_backup:/tmp/BT_backup jslay88/qbt_migrate -e X:\ -n Z:\ # Windows to Windows (Drive letter change) docker run -v %LOCALAPPDATA%/qBittorrent/BT_backup:/tmp/BT_backup jslay88/qbt_migrate -e X:\Torrents -n X:\NewDir\Torrents -t Windows # Windows to Windows (Directory Change) ... -Mounting in the default BT_Backup path on a Linux/Mac machine running Docker +Mounting in the default BT_backup path on a Linux/Mac machine running Docker docker run -v $HOME/.local/share/data/qBittorrent/BT_backup:/tmp/BT_backup jslay88/qbt_migrate -e X:\ -n Z:\ # Windows to Windows (Drive letter change) docker run -v $HOME/.local/share/data/qBittorrent/BT_backup:/tmp/BT_backup jslay88/qbt_migrate -e X:\Torrents -n X:\NewDir\Torrents -t Windows # Windows to Windows (Directory Change) ... -If for some reason you wanted to override BT_Backup path from `/tmp/BT_Backup` within the container, simply set +If for some reason you wanted to override BT_backup path from `/tmp/BT_backup` within the container, simply set environment variable `BT_BACKUP_PATH` on the container to where you will be mounting in. **The `-e` for environment variable override must go before the image `jslay88/qbt_migrate` as the `-e` after the image is for `--existing-path`** @@ -88,7 +88,7 @@ environment variable `BT_BACKUP_PATH` on the container to where you will be moun You can also clone this repository, build the image, and run your own built image docker build . -t qbt_migrate - docker run -v %LOCALAPPDATA%/qBittorrent/BT_Backup:/tmp/BT_backup qbt_migrate -e X:\ -n Z:\ # Windows to Windows (Drive letter change) + docker run -v %LOCALAPPDATA%/qBittorrent/BT_backup:/tmp/BT_backup qbt_migrate -e X:\ -n Z:\ # Windows to Windows (Drive letter change) ... diff --git a/qbt_migrate/classes.py b/qbt_migrate/classes.py index c631478..731467c 100644 --- a/qbt_migrate/classes.py +++ b/qbt_migrate/classes.py @@ -40,7 +40,7 @@ def run( :type new_path: str :param target_os: If targeting a different OS than the source. Must be Windows, Linux, or Mac. :type target_os: str - :param create_backup: Create a backup archive of the BT_Backup directory? + :param create_backup: Create a backup archive of the BT_backup directory? :type create_backup: bool :param skip_bad_files: Skip .fastresume files that cannot be read successfully. :type skip_bad_files: bool diff --git a/qbt_migrate/cli.py b/qbt_migrate/cli.py index 98b69e3..cbe418a 100644 --- a/qbt_migrate/cli.py +++ b/qbt_migrate/cli.py @@ -20,7 +20,7 @@ def parse_args(): choices=["Windows", "Linux", "Mac"], ) parser.add_argument( - "-b", "--bt-backup-path", help="BT_Backup Path Override. " f"Default is {discover_bt_backup_path()}" + "-b", "--bt-backup-path", help="BT_backup Path Override. " f"Default is {discover_bt_backup_path()}" ) parser.add_argument( "-s", @@ -47,7 +47,7 @@ def main(): if args.bt_backup_path is not None: qbm.bt_backup_path = args.bt_backup_path else: - bt_backup_path = input(f"BT_Backup Path {qbm.bt_backup_path}: ") + bt_backup_path = input(f"BT_backup Path {qbm.bt_backup_path}: ") if bt_backup_path.strip(): qbm.bt_backup_path = bt_backup_path if args.existing_path is None: diff --git a/setup.py b/setup.py index 7d3ecbb..bdecff1 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ setup( name="qbt_migrate", - version="2.1.5", + version="2.1.6", packages=find_packages(), install_requires=dependencies, description="Migrate qBittorrent FastResume files.",