Unshackle - Modular Movie, TV, and Music Archival Software

[sipho]

It all happens in core/titles/episode.py. You'll see lots of 'name += whatever ' that just add garbage to titles.

The name is set perfectly well at line 107 in episode.py after that try commenting out any line starting name +=
If name += is directly underneath an if statement - you'll need to add 'pass' indented underneath if... or comment out the if statement entirely.

the same thing needs doing in core/titles/movie.py and core/titles/song.py too!!

Edit: I've found a better way. lots of edits but this works and produced this save:-

Thank you kindly! Before you added the better way, I was able to edit the episode.py file and comment out all the name += lines and this worked rather well. Your later edit is even better. Thanks again.

[Tom Saurus]

I would at the beginning of the download process write the name of the series in Notepad and just use it to copy and paste when you chose to rename the folder. As for episodes names there are programs such as Rename My TV Series. Hint for shows like "Love Boat" just leave them as they are as they are too much of a pain to rename the episodes.

Thank you Tom. I use filebot to rename stuff after the fact but wanted to have downloaded files cleaned up before processing. phased has the answer I was looking for.

You are welcome and phased did provide a terrific method. Also I may give filebot a try. I have not tried Unshackle yet but I did thanks to some help get Ozvine working except for a snap when it comes to 7plus.

[deccavox]

The problem with phased's adjustments, when new commits come along at the very least you'll need to do a backup of episode.py, movie.py and song.py before doing git pull. Or, worse case, if on the new commit any of those files have been altered, you'll need to go through the whole editing rigmorole again.

What would be really super super duper is if we had an approach similar to stabby's freevine where the filename format is defined in the yaml file by the end user. Including whether output is mp4 or mkv.

[deccavox]

I wrote this little ditty to tidy up my filenames (not just devine/ unshackle but from other sources like scene). I called it 'filename_strip.py'
I copy it into the folder that contains as many files as I want to be cleaned up. Double click it and it tidies each file taking a fraction of a second per file. It takes in mkv and mp4 files.

As an example
Grace.S05E01.Dead.If.You.Dont.1080p.ITV.WEB-DL.AAC2.0.H.264-user_tag.mkv
becomes
Grace S05E01 Dead If You Dont [1080p] [subs].mkv

'''Strips all text from a filename after the resolution, removes dots and add '[subs]' at the end'''

import os
import re

def rename_files():
    # Get all mp4 and mkv files in the current directory
    files = [f for f in os.listdir('.') if f.endswith(('.mp4', '.mkv'))]

    for file in files:
        # Extract everything up to and including the resolution
        match = re.search(r'(.+?\d+[pP])', file, re.IGNORECASE)
        if match:
            new_name = match.group(1)
            
            # Extract the resolution and surround with brackets
            resolution = re.search(r'(\d+[pP])$', new_name, re.IGNORECASE)
            if resolution:
                resolution = f"[{resolution.group(1).lower()}]"
                new_name = new_name[:-len(resolution)+2]  # Remove resolution from main name
            
            # Replace dots with spaces and clean up
            new_name = new_name.replace('.', ' ').strip()
            
            # Get the original file extension
            _, ext = os.path.splitext(file)
            
            # Construct the final name
            new_name = f"{new_name} {resolution} [subs]{ext}"
            
            # Rename the file
            os.rename(file, new_name)
            print(f"Renamed: {file} -> {new_name}")

if __name__ == "__main__":
    rename_files()
    print("Renaming complete.")

[phased]

The problem with phased's adjustments, when new commits come along at the very least you'll need to do a backup of episode.py, movie.py and song.py before doing git pull. Or, worse case, if on the new commit any of those files have been altered, you'll need to go through the whole editing rigmorole again.

What would be really super super duper is if we had an approach similar to stabby's freevine where the filename format is defined in the yaml file by the end user. Including whether output is mp4 or mkv.

I've asked a friend to make a pull request to unshackle on github so the naming change can be added to the repo.

[mickmars]

I wrote this little ditty to tidy up my filenames (not just devine/ unshackle but from other sources like scene). I called it 'filename_strip.py'
I copy it into the folder that contains as many files as I want to be cleaned up. Double click it and it tidies each file taking a fraction of a second per file. It takes in mkv and mp4 files.

As an example
Grace.S05E01.Dead.If.You.Dont.1080p.ITV.WEB-DL.AAC2.0.H.264-user_tag.mkv
becomes
Grace S05E01 Dead If You Dont [1080p] [subs].mkv
[code]
'''Strips all text from a filename after the resolution, removes dots and add '[subs]' at the end'''

import os
import re

def rename_files():
# Get all mp4 and mkv files in the current directory
files = [f for f in os.listdir('.') if f.endswith(('.mp4', '.mkv'))]

for file in files:
# Extract everything up to and including the resolution
match = re.search(r'(.+?\d+[pP])', file, re.IGNORECASE)
if match:
new_name = match.group(1)

# Extract the resolution and surround with brackets
resolution = re.search(r'(\d+[pP])$', new_name, re.IGNORECASE)
if resolution:
resolution = f"[{resolution.group(1).lower()}]"
new_name = new_name[:-len(resolution)+2] # Remove resolution from main name

# Replace dots with spaces and clean up
new_name = new_name.replace('.', ' ').strip()

# Get the original file extension
_, ext = os.path.splitext(file)

# Construct the final name
new_name = f"{new_name} {resolution} [subs]{ext}"

# Rename the file
os.rename(file, new_name)
print(f"Renamed: {file} -> {new_name}")

if __name__ == "__main__":
rename_files()
print("Renaming complete.")
[code]

Hi Decca,

Are you saying to open notepad, copy paste that whole code into new txt file, then save it as a .py file called filename_strip.py ?

[denjimakima]

Everyone iPlayer working for you?
mine says ConnectionError: Failed to request the M3U(8) document.

[phased]

A repository branch with the scene_naming as an option in unshackle.yaml is now available for testing; https://github.com/unshackle-dl/unshackle/tree/feature/scene-naming-option.
scene_naming: true gives episode titles like this Prime.Suspect.S07E01.The.Final.Act.-.Part.One.1080p.ITV.WEB-DL.AAC2.0.H.264
scene_naming: false gives episode titles like this Prime.Suspect S07E01 The Final Act - Part One

I guess it will be released to the main branch in due course.

[deccavox]

Hi Decca,

Are you saying to open notepad, copy paste that whole code into new txt file, then save it as a .py file called filename_strip.py ?

yes, exactly. You can call it what you want just so long as the file extension is .py

[sipho]

A repository branch with the scene_naming as an option in unshackle.yaml is now available for testing; https://github.com/unshackle-dl/unshackle/tree/feature/scene-naming-option.
scene_naming: true gives episode titles like this Prime.Suspect.S07E01.The.Final.Act.-.Part.One.1080p.ITV.WEB-DL.AAC2.0.H.264
scene_naming: false gives episode titles like this Prime.Suspect S07E01 The Final Act - Part One

I guess it will be released to the main branch in due course.

Great work!

[mickmars]

Try as I might I cannot get unshackle to find my services , My yaml says

directories:
services: .\unshackle/unshackle/services
cache: .\cache
cookies: .\cookies
# dcsl: DCSL # Device Certificate Status List
downloads: .\Downloads
logs: .\Logs
temp: .\temp
WVDs: .\unshackle\WVDs


But when I check my unshackle env info, I get

No config file found, you can use any of the following locations:
├── 1.
│ C:\Users\palmer\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
│ es\unshackle\unshackle.yaml
├── 2.
│ C:\Users\palmer\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
│ es\unshackle.yaml
└── 3.
C:\Users\palmer\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
es\unshackle\unshackle.yaml

Directories
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━┓
┃ Name ┃ Path ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━┩
│ Cache │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\cache │
│ Commands │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\commands │
│ Cookies │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\cookies │
│ Core_Dir │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\core │
│ Data │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle │
│ Dcsl │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\DCSL │
│ Downloads │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\dow │
│ │ nloads │
│ Fonts │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\fonts │
│ Logs │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\logs │
│ Namespace_Dir │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle │
│ Prds │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\PRDs │
│ Services │ C:\Users\palmer\AppData\Roaming\uv\tools\unshackle │
│ │ \Lib\site-packages\unshackle\services │
│ Temp │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\tem │
│ │ p │
│ User_Configs │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle │
│ Vaults │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\vaults │
│ Wvds │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\WVDs │
└───────────────┴───────────────────────────────── ───────────────────┘


Anu suggestions would be much appreciated

[ImSp4rky]

Try as I might I cannot get unshackle to find my services , My yaml says

directories:
services: .\unshackle/unshackle/services
cache: .\cache
cookies: .\cookies
# dcsl: DCSL # Device Certificate Status List
downloads: .\Downloads
logs: .\Logs
temp: .\temp
WVDs: .\unshackle\WVDs


Anu suggestions would be much appreciated

Since you installed with uv tool everything is kept within the venv location which can be confusing if you're unsure.

Best to just revert

uv tool uninstall unshackle

and then just git clone and then inside the folder

uv sync

following this guide https://github.com/unshackle-dl/unshackle?tab=readme-ov-file#installation

This is the best way to handle it at the moment but you could get fancier with

setx UV_TOOL_BIN_DIR "C:\Tools\Unshackle"

etc but I'd recommend reading into UV some more if you want to break out from the normal installation.

[kev043]

Everyone iPlayer working for you?
mine says ConnectionError: Failed to request the M3U(8) document.

I tested it last night and it worked fine for me, I'll test again.

just tested it today and it's working fine again.

[kev043]

Try as I might I cannot get unshackle to find my services , My yaml says

directories:
services: .\unshackle/unshackle/services
cache: .\cache
cookies: .\cookies
# dcsl: DCSL # Device Certificate Status List
downloads: .\Downloads
logs: .\Logs
temp: .\temp
WVDs: .\unshackle\WVDs


But when I check my unshackle env info, I get

No config file found, you can use any of the following locations:
├── 1.
│ C:\Users\palmer\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
│ es\unshackle\unshackle.yaml
├── 2.
│ C:\Users\palmer\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
│ es\unshackle.yaml
└── 3.
C:\Users\palmer\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
es\unshackle\unshackle.yaml

Directories
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━┓
┃ Name ┃ Path ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━┩
│ Cache │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\cache │
│ Commands │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\commands │
│ Cookies │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\cookies │
│ Core_Dir │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\core │
│ Data │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle │
│ Dcsl │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\DCSL │
│ Downloads │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\dow │
│ │ nloads │
│ Fonts │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\fonts │
│ Logs │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\logs │
│ Namespace_Dir │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle │
│ Prds │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\PRDs │
│ Services │ C:\Users\palmer\AppData\Roaming\uv\tools\unshackle │
│ │ \Lib\site-packages\unshackle\services │
│ Temp │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\tem │
│ │ p │
│ User_Configs │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle │
│ Vaults │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\vaults │
│ Wvds │ %APPDATA%\uv\tools\unshackle\Lib\site-packages\uns │
│ │ hackle\WVDs │
└───────────────┴───────────────────────────────── ───────────────────┘


Anu suggestions would be much appreciated

this how I have my yaml setup, I hope this can help you.

directories:
  cache: C:\Users\xxxx\unshackle\Cache
  cookies: C:\Users\xxxx\unshackle\Cookies
  dcsl: DCSL # Device Certificate Status List
  downloads: C:\Users\xxxx\unshackle\Downloads
  logs: C:\Users\xxxx\unshackle\Logs
  temp: C:\Users\xxxx\unshackle\Temp
  wvds: C:\Users\xxxx\unshackle\WVDs
#  prds: PRDs
  # Additional directories that can be configured:
  # commands: Commands
  services:
    - C:\Users\xxxx\unshackle\Services
  # vaults: Vaults
  # fonts: Fonts

[mickmars]

Try as I might I cannot get unshackle to find my services , My yaml says

directories:
services: .\unshackle/unshackle/services
cache: .\cache
cookies: .\cookies
# dcsl: DCSL # Device Certificate Status List
downloads: .\Downloads
logs: .\Logs
temp: .\temp
WVDs: .\unshackle\WVDs


Anu suggestions would be much appreciated

Since you installed with uv tool everything is kept within the venv location which can be confusing if you're unsure.

Best to just revert

uv tool uninstall unshackle

and then just git clone and then inside the folder

uv sync

following this guide https://github.com/unshackle-dl/unshackle?tab=readme-ov-file#installation

This is the best way to handle it at the moment but you could get fancier with

setx UV_TOOL_BIN_DIR "C:\Tools\Unshackle"

etc but I'd recommend reading into UV some more if you want to break out from the normal installation.

I get that you are advising me to uninstall unshackle , I originally installed it using these codes

git clone https://github.com/unshackle-dl/unshackle.git
cd unshackle
uv sync
uv run unshackle --help

that's one of the four installation instructions in the github guide that you pointed me to
should I be using one of the other three installation instructions ?

[kev043]

Try as I might I cannot get unshackle to find my services , My yaml says

directories:
services: .\unshackle/unshackle/services
cache: .\cache
cookies: .\cookies
# dcsl: DCSL # Device Certificate Status List
downloads: .\Downloads
logs: .\Logs
temp: .\temp
WVDs: .\unshackle\WVDs


Anu suggestions would be much appreciated

Since you installed with uv tool everything is kept within the venv location which can be confusing if you're unsure.

Best to just revert

uv tool uninstall unshackle

and then just git clone and then inside the folder

uv sync

following this guide https://github.com/unshackle-dl/unshackle?tab=readme-ov-file#installation

This is the best way to handle it at the moment but you could get fancier with

setx UV_TOOL_BIN_DIR "C:\Tools\Unshackle"

etc but I'd recommend reading into UV some more if you want to break out from the normal installation.

I get that you are advising me to uninstall unshackle , I originally installed it using these codes

git clone https://github.com/unshackle-dl/unshackle.git
cd unshackle
uv sync
uv run unshackle --help

that's one of the four installation instructions in the github guide that you pointed me to
should I be using one of the other three installation instructions ?

git clone https://github.com/unshackle-dl/unshackle.git
cd unshackle
uv sync
uv run unshackle --help

That's the command I used from inside my C:\Users\xxxx\ folder I just ran it from there, also did you install uv? from command prompt I ran

 pip install uv

[mickmars]

Try as I might I cannot get unshackle to find my services , My yaml says

directories:
services: .\unshackle/unshackle/services
cache: .\cache
cookies: .\cookies
# dcsl: DCSL # Device Certificate Status List
downloads: .\Downloads
logs: .\Logs
temp: .\temp
WVDs: .\unshackle\WVDs


Anu suggestions would be much appreciated

Since you installed with uv tool everything is kept within the venv location which can be confusing if you're unsure.

Best to just revert

uv tool uninstall unshackle

and then just git clone and then inside the folder

uv sync

following this guide https://github.com/unshackle-dl/unshackle?tab=readme-ov-file#installation

This is the best way to handle it at the moment but you could get fancier with

setx UV_TOOL_BIN_DIR "C:\Tools\Unshackle"

etc but I'd recommend reading into UV some more if you want to break out from the normal installation.

I get that you are advising me to uninstall unshackle , I originally installed it using these codes

git clone https://github.com/unshackle-dl/unshackle.git
cd unshackle
uv sync
uv run unshackle --help

that's one of the four installation instructions in the github guide that you pointed me to
should I be using one of the other three installation instructions ?

git clone https://github.com/unshackle-dl/unshackle.git
cd unshackle
uv sync
uv run unshackle --help

That's the command I used from inside my C:\Users\xxxx\ folder I just ran it from there, also did you install uv? from command prompt I ran

 pip install uv

I used

python -m pip install --user pipx followed by pipx install uv

[mickmars]

I cannot understand why my config is loading from

%APPDATA%\uv\tools\unshackle\Lib\site-packages\uns
hackle\cache

when,in my opinion, it should be loading from

%USERPROFILE%\unshackle

[iamghost]

because you didnt add unshackle.yaml

[Attachment 88106 - Click to enlarge]

your name/unshackle/"ADD FOLDER" name - Logs, Temp, WVDs, etc

[mickmars]

because you didnt add unshackle.yaml

[Attachment 88106 - Click to enlarge]

your name/unshackle/"ADD FOLDER" name - Logs, Temp, WVDs, etc

changing my yaml Logs, Temp, WVDs, etc to
C:\Users\xxxxxx\unshackle\

made absolutely no difference

[mickmars]

[Attachment 88110 - Click to enlarge]


[Attachment 88111 - Click to enlarge]

Should unshackle really be in two different places on my computer ?

[iamghost]

delete .venv
make sure use / not \

directories:
  services: ./unshackle/services
  cache: ./cache
  cookies: ./cookies
  # dcsl: DCSL # Device Certificate Status List
  downloads: ./Downloads
  logs: ./Logs
  temp: ./temp
  WVDs: ./unshackle/WVDs

then install.bat

[SaLTy]

How do we update unshackle? With devine it used to be pip install devine --upgrade but as unshackle doesn't use pip we can't do that.

[iamghost]

git pull https://github.com/unshackle-dl/unshackle.git

[mickmars]

what do I put in my yaml to make the configuration load from

C:\Users\xxxxxx\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
es\unshackle\unshackle.yaml

[phased]

what do I put in my yaml to make the configuration load from

C:\Users\xxxxxx\AppData\Roaming\uv\tools\unshackle \Lib\site-packag
es\unshackle\unshackle.yaml

What are you asking? You want unshackle to load its yaml so it can find out where to load the yaml from? How is that going to work?

[deccavox]

Hi

I've had a thought. You've been concentrating on getting unshackle installed but where are your environment dependencies? I have all mine in a special folder which I have referenced as PATHs within my Windows Environment Variables. Another option would be to have them within your unshackle folder. I am talking about the likes of ffmpeg, ffprobe, MKVToolNix (mkvmerge, mkvpropedit), aria2c, N_m3u8DL-RE, shaka-packager (renamed to packager-win-x64), ccextractor.

Try running

uv run unshackle env check

to see what it recognises.

[SaLTy]

git pull https://github.com/unshackle-dl/unshackle.git

Thanks

[sipho]

Hi

I've had a thought. You've been concentrating on getting unshackle installed but where are your environment dependencies? I have all mine in a special folder which I have referenced as PATHs within my Windows Environment Variables. Another option would be to have them within your unshackle folder. I am talking about the likes of ffmpeg, ffprobe, MKVToolNix (mkvmerge, mkvpropedit), aria2c, N_m3u8DL-RE, shaka-packager (renamed to packager-win-x64), ccextractor.

To add to this, the last couple of releases have included a folder for this very reason.

unshackle\unshackle\binaries

[mickmars]

Hi

I've had a thought. You've been concentrating on getting unshackle installed but where are your environment dependencies? I have all mine in a special folder which I have referenced as PATHs within my Windows Environment Variables. Another option would be to have them within your unshackle folder. I am talking about the likes of ffmpeg, ffprobe, MKVToolNix (mkvmerge, mkvpropedit), aria2c, N_m3u8DL-RE, shaka-packager (renamed to packager-win-x64), ccextractor.

Try running

uv run unshackle env check

to see what it recognises.

Environment Dependencies
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━ ━━┳━━━━━━━━━━━━━━━━━━━━━━┓
┃ Category ┃ Tool ┃ Status ┃ Req ┃ Purpose ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━ ━━╇━━━━━━━━━━━━━━━━━━━━━━┩
│ Core │ FFmpeg │ ✓ │ Y │ Media processing │
│ │ FFprobe │ ✓ │ Y │ Media analysis │
│ │ MKVToolNix │ ✓ │ Y │ MKV muxing │
│ │ mkvpropedit │ ✓ │ Y │ MKV metadata │
│ DRM │ shaka-packager │ ✓ │ Y │ DRM decryption │
│ │ mp4decrypt │ ✓ │ - │ DRM decryption │
│ HDR │ dovi_tool │ ✗ │ - │ Dolby Vision │
│ │ HDR10Plus_tool │ ✗ │ - │ HDR10+ metadata │
│ Download │ aria2c │ ✓ │ - │ Multi-thread DL │
│ │ N_m3u8DL-RE │ ✓ │ - │ HLS/DASH/ISM │
│ Subtitle │ SubtitleEdit │ ✗ │ - │ Sub conversion │
│ │ CCExtractor │ ✓ │ - │ CC extraction │
│ Player │ FFplay │ ✓ │ - │ Simple player │
│ │ MPV │ ✗ │ - │ Advanced player │
│ Network │ HolaProxy │ ✗ │ - │ Proxy service │
│ │ Caddy │ ✗ │ - │ Web server │
└────────────┴──────────────────┴────────────┴──── ──┴──────────────────────┘


Total: 10/16 All required tools installed ✓