Skip to main content

KickassTorrents CLI and Telegram bot

Project description

http://i.imgur.com/ofx75lO.png

CLI client to torrent searches and streaming. Easily search torrents in multiple providers such as KickAssTorrents and ThePirateBay.

pypi release downloads python_versions pypi_versions actions

Usage

katcr comes with a simple but powerful command line interface

USAGE
  console search [--pages <...>] [--token [<...>]] [--shortener [<...>]] [--engines <...>] [--interactive [<...>]]
                 [--open [<...>]] [--stream [<...>]] <search>

ARGUMENTS
  <search>               Search term

OPTIONS
  --pages                Pages to search on search engines (default: "1")
  --token                Token to use on URL shortener as AUTH
  --shortener            URL Shortener
  --engines              Engines (default: "Katcr,ThePirateBay,Eztv,NyaaSi,Skytorrents")
  --interactive          Allow the user to choose a specific magnet
  --open                 Open selected magnet with xdg-open
  --stream               Stream with torrentstream, plays using PLAYER envvar or xdg-open

GLOBAL OPTIONS
  -h (--help)            Display this help message
  -q (--quiet)           Do not output any message
  -v (--verbose)         Increase the verbosity of messages: "-v" for normal output, "-vv" for more verbose output
                         and "-vvv" for debug
  -V (--version)         Display this application version
  --ansi                 Force ANSI output
  --no-ansi              Disable ANSI output
  -n (--no-interaction)  Do not ask any interactive question

Installation

This is a python package available on pypi, just run

pip install katcr

Make sure your python version is at least python3.8 and you’re using that version’s pip.

Streaming

Streaming requires libtorrent . With libtorrent installed, you’ll need to install katcr’s streaming extras, for that matter, install it with [stream],

pip install katcr[stream]

Then, just run it with

poetry run katcr search --engines Skytorrents,ThePirateBay "Big Buck Bunny" --interactive  --stream

Features

  • Display results in a nice utf-8 table

  • Optional interactive mode, choose and open torrent with a nice text user interface

  • Open torrent directly with your preferred client (via xdg-open)

  • Stream torrent with torrentstream

  • Searches on all available engines until it gets results by default.

  • Search torrents in:

    • Eztv

    • Jackett

    • Katcr

    • NyaaSi

    • Skytorrents

    • ThePirateBay

Jackett Support

You can easily use a Jackett instance to search on all your configured provider.

This allows you to search on any jackett-supported site (that’s about supported 300 trackers).

Jackett is probably the best way to use katcr and katbot, as it has a more active mantainance of the tracker sites that us.

To enable Jackett use, simply export your jackett URL and TOKEN as variables:

JACKETT_HOST=http://127.0.0.1:9117 JACKETT_APIKEY=<redacted> poetry run katcr --engines=

Notes

This project is made with the best of intentions.

For that times you need to search for somethink shared as a torrent on KAT (I.E, linux images). Logo is based on robot cat by Arsenty

If you like this project, show its appreciation by starring it, if you’re using it and want to write to me personally, feel free to do so at opensource@davidfrancos.net. If you’ve got a bug to report, please use the github ticketing system

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

katcr-3.0.0a1.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

katcr-3.0.0a1-py3-none-any.whl (9.0 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