killedmufasa / amputatorbot

Remove AMP from your URLs. AmputatorBot is a highly specialised Reddit and Twitter bot that automatically replies to comments, submissions and tweets containing AMP URLs with the canonical link(s). It's also available as a website and REST API. See also: https://www.reddit.com/r/AmputatorBot/comments/ehrq3z/why_did_i_build_amputatorbot/.

TL;DR: Remove AMP from your URLs. AmputatorBot is a highly specialised Reddit (and former Twitter) bot that automatically replies to comments and submissions containing AMP URLs with the canonical link(s). It's also available as a website and REST API, but those haven't been made open source here.

FAQ, About & Why

Features

Main features:

• 10 specialised canonical-finding methods, allowing for an accuracy rate of +97%. For example, by:
  • Scanning the HTML contents
  • Detecting and following redirects
  • Guessing, and then checking article similarity with newspaper
  • … and many more!
• Detect AMP links using 14 patterns, and reply to items containing them with the canonical link and some info
• Compare and test canonicals and pick the best
• Stream Reddit comments, submissions and inbox messages
• Extensively tested using a (private) database of over 200K AMP links and their canonicals, also functioning as caching

Nice bonuses:

• Detect unique URLs with URLExtract and strip them of any artifacts
• Object-oriented, allowing for a handy, free and publicly available API
• Allow users to opt out and undo this
• Send DMs when summoned by a user
• Items interacted with are automatically being tracked
• Log and datafiles are automatically generated

See also:

• Online version: AmputatorBot.com
• Free and publicly available REST API to convert AMP URLs to canonical links: API Documentation & Postman
• User-oriented, simplified changelog: Changelog
• Community & Subreddit: r/AmputatorBot

Set up

1. Clone the repository
2. Run pip install -r requirements.txt to install dependencies
3. Change the filename of static.txt to .py (see /static)
4. Configure the application by tweaking static.py (required)
5. Choose a check-[...].py script to run
6. Configure the script's settings in run_bot(). Set everything (guess_and_check, reply_to_post, save_to_database) to False when starting out. Consider deleting or disabling the database canonical method.
7. Run the script - All logs and required datafiles should be automatically and dynamically created.
8. Stop the script.
9. Check out the new files in /data and edit them to your liking.
10. Re-run the script and enjoy!

Support the project

• Summon AmputatorBot on Reddit, like so: u/AmputatorBot. For more info, see here.
• Give feedback: Most new features and improvements are directly influenced by your feedback. So, hit me up if you have any feedback. Contact me on Reddit or Fill an issue.
• Star: By starring the project here on GitHub, we can reach more folks and unlock new options. It also gives me something to brag about :p
• Contribute: Pull requests are a great way to contribute directly to the code and functionality.
• Spread the word: In the end, the only goal of AmputatorBot is to allow people to have an informed choice. You can help by simply spreading the word!

Sponsor

The server for the bot, website, and API costs about €10 ($12) per month. If you support AmputatorBot's mission and can chip in, any donation would be a huge help. Every bit goes straight into server expenses. Thanks a bunch!

PayPal: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EU6ZFKTVT9VH2
Or, donate to our friends in Ukraine instead: https://u24.gov.ua

From the bottom of my heart, huge thanks for the tremendous support! <3