ant-upload-checker 1.6.2

Check if local films have already been uploaded to ANT

ANT upload checker

What does this script do?

This script is intended to be used on a directory containing films. It scans for films, parses their title and resolution, and checks whether a given film and its resolution already exists on ANT. The script outputs a csv file containing the film list along with information on whether it's been uploaded or not. The idea is to help find films in your library that could potentially be uploaded.

Example CSV output:

Full file path	Parsed film title	Film size (GB)	Resolution	Codec	Source	Release group	Already on ANT?
C:\Movies\25th Hour 2002 1080p BluRay DTS x264-GrapeHD.mkv	25th Hour	18.9	1080p	H.264	Blu-ray	GrapeHD	Resolution already uploaded: link
C:\Movies\A Clockwork Orange (1971) [imdbid-tt0066921] - [Bluray-1080p][HDR10][Opus 1.0][x265]-ZQ.mkv	A Clockwork Orange	23.21	1080p	H.265	Blu-ray	ZQ	Resolution already uploaded: link
C:\Movies\A Man Called Otto (2022) [imdbid-tt7405458] - [Bluray-1080p][EAC3 5.1][x264]-playHD.mkv	A Man Called Otto	16.83	1080p	H.264	Blu-ray	playHD	Resolution already uploaded: link

How does it work?

The process searches through the given directory (or multiple directories), and finds all common video file formats (currently: mp4, avi, mkv, mpeg and m2ts). Using an existing package called guessit and some additional processing, film titles and their resolutions are parsed from the file paths. For each film, a get request is sent to ANT's API, to check whether it can be found already. For certain titles, if an initial match is not found, the title is tweaked and re-searched. For example, films containing "and" could be spelt with "and" or "&", so both titles are checked.

The script outputs a csv file containing a list of films it's found and whether they've been found on ANT or not.

If an existing film_list.csv is found in the output location specified, any films in this that have already been found on ANT will be skipped by the process. This means you can re-run the script without having to search through your whole film library again. It will not skip films that were not found on ANT, and any new films in your library.

This is a work in progress - please feel free to give helpful feedback and report bugs.

Known issues

• Non-english films may not be found on ANT if their titles do not match
• Films with ellipsis may not be found. Currently guessit automatically removes these e.g. Tick Tick... BOOM! -> Tick Tick Boom!
• Films with alternate titles (Film X AKA Film Y) will not be found on ANT

Prerequisites

• You must have Python v 3.8 or later installed: https://www.python.org/downloads/windows/
• You must be a member of ANT
  • Please do not message me for an invite, or open issues requesting one, these will be ignored. ANT Staff is aware of and monitors this repo
• If you are on Linux, note that some Python installations don't come with a package called Tkinter which is required.
  • If you are prompted to install it, choose the command based on your Linux system, or see here for more info: https://stackoverflow.com/questions/4783810/install-tkinter-for-python
    • Debian/Ubuntu: sudo apt install python3-tk -y
    • Fedora: sudo dnf install -y python3-tkinter
    • Arch: sudo pacman -Syu tk --noconfirm
    • REHL/CentOS6/CentOS7: sudo yum install -y python3-tkinter
    • OpenSUSE: sudo zypper in -y python-tk

How to setup and run ant_upload_checker

1. Optional step: setup a virtual environment (recomended but not required)
   • A virtual environment lets you install a package and its dependencies in a contained area, keeping it seperate from other Python projects on your system. It's good practise to use a virtual environment, but if you're not fussed about running other Python projects, or if you want to install it globally instead, feel free to skip this step (see https://docs.python.org/3/tutorial/venv.html for more info)
   • Navigate to where you want to store the package
   • From the command line (e.g. Command Prompt) type python -m venv .venv. This should create a folder called .venv containing the virtual environment.
   • Then activate the virtual environment
     • Windows: If in a Command Prompt, type .venv/Scripts/activate. If using PowerShell, type .venv/Scripts/Activate.ps1
     • Linux: source .venv/bin/activate
2. Install the package
   • From the command line (e.g. Command Prompt) type pip install ant-upload-checker. This should install the package from PyPI
3. Run the package
   • Once installed, type ant-upload-checker to run the package
   • You should be asked for your ANT API key - you can paste this in after copying it from ANT
   • A dialog box should then open asking for your input folders (where your films are stored)
   • Finally, another dialog box should ask you to specify your output folder (where the film list CSV should be written)
   • When you run it for a second time, you can skip this stage by selecting "No" when asked whether you want to overwrite your existing settings
4. Check the output file
   • Open the output csv file to see which films already exist on the tracker
   • Please remember this is a work in progress - feel free to report any issues you come across!

How to update to the latest version

Assuming you've already installed ant_upload_checker, type pip install --upgrade ant-upload-checker. If there's a new version available, it should update the version you have installed.

Remember that if you originally installed the package into a virtual environment, you will need to first activate the virtual environment again (navigate to the folder, type .venv/Scripts/Activate.ps1 for Windows or source .venv/bin/activate for Linux)

How to work on the code

If you want to do any development work, don't install from PyPi. Instead:

1. Git clone the repository
2. Setup a virtual environment in the root directory (see step 1 of 'How to setup and run ant_upload_checker').
3. In the command line type pip install -e .[test]. This should install the package and the optional test dependencies.

Planned improvements

• Enhance film check to include other attributes (exact filename check, codec, source info etc.)
• Continue code refactor, finish adding type hints
• Add a CLI for those unable to use GUI
• Increase max file path length
• Add automatic torrent creator using torf

See the changelog for recent changes.