Metadata-Version: 2.1
Name: qbt_migrate
Version: 2.1.0
Summary: Migrate qBittorrent FastResume files.
Home-page: https://github.com/jslay88/qbt_migrate
Author: jslay88
License: UNKNOWN
Description: # qBt Migrate
        This tool changes the root paths of existing torrents in qBittorrent.
        It can also convert slashes when migrating between Windows and Linux/Mac.
        
        ## Usage
        
        Install from PyPi using `pip`, or jump to [Examples](#Examples) for Docker
        
            pip install qbt-migrate
            
        Run the script and follow prompts or use CLI arguments with command `qbt_migrate`
        
            usage: qbt_migrate [-h] [-e EXISTING_PATH] [-n NEW_PATH] [-t {Windows,Linux,Mac}]
                      [-b BT_BACKUP_PATH] [-l {DEBUG,INFO}]
            
            optional arguments:
              -h, --help            show this help message and exit
              -e EXISTING_PATH, --existing-path EXISTING_PATH
                                    Existing root of path to look for.
              -n NEW_PATH, --new-path NEW_PATH
                                    New root path to replace existing root path with.
              -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. 
              -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.
        Override `BT_Backup` path if needed.
        
        Default BT_Backup paths:
        * Windows: `%LOCALAPPDATA%/qBittorrent/BT_Backup`
        * Linux/Mac: `$HOME/.local/share/data/qBittorrent/BT_backup`
        
        A backup zip archive is automatically created in the directory that contains
        the `BT_Backup` directory. Default, for instance, would be the `qBittorrent` directory mentioned above.
        
        ### Examples
        Assuming all of our torrents are in `X:\Torrents` when coming from Windows, or `/torrents` when coming from Linux/Mac
        
            qbt_migrate -e X:\ -n Z:\ -t Windows  # Windows to Windows (Drive letter change)
            qbt_migrate -e X:\Torrents -n X:\NewDir\Torrents -t Windows  # Windows to Windows (Directory Change)
            qbt_migrate -e X:\Torrents -n Z:\NewDir\Torrents -t Windows  # Windows to Windows (Drive letter change with directory change)
            qbt_migrate -e X:\Torrents -n /torrents -t Linux  # Windows to Linux/Mac (converts slashes)
            
            qbt_migrate -e /torrents -n /new/path/for/torrents  # Changes torrent root path on Linux/Mac
            qbt_migrate -e /torrents -n Z:\Torrents -t Windows  # Linux/Mac to Windows (converts slashes)
        
        #### 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 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
        
            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
        
            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 
        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`**
        
            docker run -v %LOCALAPPDATA%/qBittorrent/BT_Backup:/opt/qbt_migrate/fastresume -e BT_BACKUP_PATH=/opt/qbt_migrate/fastresume jslay88/qbt_migrate -e X:\ -n Z:\  # Windows to Windows (Drive letter change)
            ...
        
        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)
            ...
        
Platform: UNKNOWN
Requires-Python: >=3.6.4
Description-Content-Type: text/markdown
