diff --git a/readme.md b/readme.md index cec23be..f73b3a4 100644 --- a/readme.md +++ b/readme.md @@ -1,12 +1,14 @@ # Pirate -Command line HTML parser/scraper used for grabbing torrents from [ThePirateBay](https://thepiratebay.se). Downloads torrents using command line program, transmission-daemon. +Command line torrent downloader. + +Parses HTML pages on [ThePirateBay](https://thepiratebay.se) based on a search string provided. Downloads torrents using transmission-daemon. Initially made for the older version with torrents hosted from a separate subdomain, but now modified for grabbing magnet links instead. ---- -## Requirements +### Requirements This script was written in Python version 2.7. Version 3 compatibility requires rewriting some code, and may be done at a later time. Pull requests welcome. @@ -16,13 +18,13 @@ This script depends on 3 external Python libraries. Please ensure the following * requests * beautifulsoup4 -If pip is installed, just run: +If pip is installed, just run the following as root: ``` pip install transmissionrpc requests beautifulsoup4 ``` -## Usage +### Usage Place the script somewhere in your executable path. I like ~/bin @@ -40,7 +42,10 @@ $ pirate.py The rest is self explanatory -## TODO +**BONUS** +Add a cron job to run //removeFinishedTorrents.py// every 5 minutes. Hook it into [PushBullet](https://pushbullet.com) for mobile notifications. + +#### TODO * Refactor code; not a fan of the spaghetti code functions * Comment script better; for personal reasons. I hate being confused 6 months later