Skip to main content

Sort screenshots based on rules or through individual review.

Project description

Social Arsenal

Sometimes someone is being a clown on the internet. Somewhere on your hard drive is the perfect screenshot to prove to the world that the clown in question is a fool, a hypocrite, a criminal, or worse. But then - horrors - you can't find the screenshot! It has been lost in your vast archive of screenshots of clowns clowning themselves on the internet.

Social Arsenal solves this.

What It Do

It sorts screenshots, PDFs, etc. based on their name and/or their textual contents into folders based on a list of rules. The contents of the tweet/reddit post/whatever are prepended to the filename and the ImageDescription EXIF tag is set to the OCR text. For example this screenshot of a tweet by a noteworthy cryptocurrency "reporter"[^1] on the eve of FTX's implosion:

Would be renamed from Screen Shot 2023-02-17 at 7.11.37 PM.png to

Tweet by @lawmaster: "I will say though before this thread gets taken over: 1. I do believe Alameda has the size to easily buy Binance\'s FIT OTC 2. I think the chance of FTX insolvency is near" Screen Shot 2023-02-17 at 7.11.37 PM.png

Other stuff that happens:

  • The ImageDescription EXIF tag will be written (for images)
  • All timestamps will be preserved.
  • If the file is not modified or renamed it will merely be moved.
  • If modifications are to be made then the original file will be moved into a Processed/ directory after it has been handled.

Note that videos are not OCRed and can only be moved based on filename matches.

Quick Start

# Installation with pipx is preferred if you have it but you can also use pip which comes standard
# on almost all systems. pipx is only a noticeably better answer if you're a python programmer who
# is concerned about side effects of pip upgrading system python packages.
pip install social arsenal

# Get help
sort_screenshots -h

# Dry run with default cryptocurrency sort rules (dry runs don't actually move anything, they just show you what)
sort_screenshots

# Execute default cryptocurrency sort rules against ~/Pictures/Screenshots
sort_screenshots --execute

# Sort a different directory of screenshots
sort_screenshots --screenshots-dir /Users/hrollins/Pictures/get_in_the_van/tourphotos --execute

# Sort with custom rules
sort_screenshots --rules-csv /Users/hrollins/my_war.csv --execute

Setup

If you want to use the popup window to manually tag you may need to install:

  • Python TK: brew install python-tk@3.10 (if you don't have homebrew you need to install it to run brew install)

Not required for standard PNG, JPG, etc. images but you may optionally install exiftool for other file types.

Usage

Help screen:

Custom Sorting Rules

The default is to sort cryptocurrency related content but you can define your own CSV of rules with two columns folder and regex. The value in folder specifies the subdirectory to sort into and regex is the pattern to match against. See the default crypto related configuration for an example. An explanation of regular expressions is beyond the scope of this README but many resources are available to help. if you're not good at regexes just remember that any alphanumeric string is a regex that will match that string. pythex is a great website for testing your regexes.

[^1]: Perhaps notable that the "reporter" in question for years maintained a private list of the blockchain addresses of Sam Bankman-Fried's various scams as part of his commitment to "unrivaled transparency".

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

social_arsenal-0.2.1.tar.gz (17.3 kB view hashes)

Uploaded Source

Built Distribution

social_arsenal-0.2.1-py3-none-any.whl (20.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page