Welcome to TinyTV documentation

Contents:

TinyTV

Ncurses interface for downloading showrss.info series, and keeping track of the watched / not watched episodes

WARNING

At ths moment, IMDB is returning error 509. I’ve switched to showrss as main data provider. Sorry for the inconvenience.

Features

  • NCurses interface for showrss.info using libtorrent streaming
  • NCurses interface for IMDB + KAT using libtorrent streaming
  • NCurses interface for direct magnet links lists (just magnets, one at a line)

Usage

usage: tinytv [-h] [--showrss_url [SHOWRSS_URL]] {imdb,showrss,magnet} PLAYER

tinytv

positional arguments:
  {imdb,showrss,magnet}
                        Interface
  PLAYER
                        Player location (I.E mplayer|omxplayer)

optional arguments:
  -h, --help            show this help message and exit
  --showrss_url [SHOWRSS_URL]
                        Showrss rss url

ShowRSS

This uses a showrss.info RSS feed to build an interface and stream.

docs/nshowrss.png?raw=true docs/chapters.png?raw=true

Magnet

Given a list of magnets, it’ll try to discover its series title/season/chapter and build an interface for it, with streaming support too.

IMDB

Gets the most popular IMDB shows and builds an interface with them. Tries to look the episodes on KAT (looks magnet links) once selected and streams it.

docs/imdb.png?raw=true

Installation

At the command line:

$ easy_install tinytv

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv tinytv
$ pip install tinytv

Usage

To use tinytv in a project:

import tinytv

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/XayOn/tinytv/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

TinyTV could always use more documentation, whether as part of the official tinytv docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/XayOn/tinytv/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up tinytv for local development.

  1. Fork the tinytv repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/tinytv.git
    
  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv tinytv
    $ cd tinytv/
    $ python setup.py develop
    
  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 tinytv tests
    $ python setup.py test
    $ tox
    

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/XayOn/tinytv/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_tinytv

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.4

  • Small fixes on docs and name stuff

0.1.3

  • Name change
  • Improved documentation

0.1.2

  • Documentation
  • Fix excessive debugging info on default interface and help

0.1.1

  • Updated pychapter version to support automatic torrent searching

  • Added support for
    • IMDB interface
    • Magnet links (via pipe) interface
    • ShowRSS.info interface

0.1.0 (2015-01-11)

  • First release on PyPI.

Indices and tables