Coder Social home page Coder Social logo

deadsec-security / popcorn-time-api Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 3.0 109 KB

Python API for interacting with the Popcorn Time Servers

License: MIT License

Python 100.00%
popcorn popcorntime popcorn-time popcorn-api popcorntimeapi popcorntime-api popcorn-time-api popcorn-sdk

popcorn-time-api's Introduction

Popcorn Time API Version Python_Version License Donate

CodeQL pre-commit.ci status

PyPI - Downloads PyPI - Downloads PyPI - Downloads

๐Ÿ“ CONTRIBUTIONS

Before doing any contribution read CONTRIBUTING.

๐Ÿ“ง CONTACT

Email: [email protected]

General Discord: https://discord.gg/dFD5HHa

Developer Discord: https://discord.gg/rxNNHYN9EQ

๐Ÿ“ฅ INSTALLING

Latest PyPI stable release

pip install popcorn-time

โš™ HOW TO USE

from popcorntime import PopcornTime
popAPI = PopcornTime()

๐Ÿค PARAMETERS

CLASS PARAMETERS

  • debug : bool, optional
    • Enable for debug mode (Default: False)
  • min_peers : int, optional
    • Minimum number of peers to select torrent (Default: 0)
  • min_seeds : int, optional
    • Minimum number of seeds to select torrent (Default: 0)

FUNCTION PARAMETERS

  • FUNCTION set_logging_level

    • level : int, required
      • Set the logging level
      • Accepted values:
        • 0: DEBUG
        • 1: INFO
        • 2: WARNING
        • 3: ERROR
        • 4: CRITICAL
        • 5: NOTSET
  • FUNCTION set_base_url

    • url : str, required
      • Set the base url for the API
  • FUNCTION set_base_url

    • url : str, required
      • Set the base url for the API
  • FUNCTION set_min_seeds

    • value : int, required
      • Minimum number of seeds to select torrent
  • FUNCTION get_server_status

    • Returns the server status in json format
  • FUNCTION get_shows_stats

    • Returns the show stats in json format
  • FUNCTION get_shows_page

    • page : (int, str), required
    • Returns the shows page in json format
  • FUNCTION get_movies_stats

    • Returns the movies stats in json format
  • FUNCTION get_movies_page

    • page : (int, str), required
    • Returns the movies page in json format
  • FUNCTION get_show

    • show_id : (int, str), required
      • IMDB ID of the show
    • Returns the show data in json format
  • FUNCTION get_movie

    • movie_id : (int, str), required
      • IMDB ID of the movie
    • Returns the movie data in json format
  • FUNCTION get_random_show

    • Returns the show in json format
  • FUNCTION get_random_movie

    • Returns the movie in json format
  • FUNCTION get_best_torrent

    • torrents : dict, required
      • The dictionary of torrents provided by the API (get_show or get_movie)
    • min_quality : int, optional
      • Minimum quality to select torrent (Default: '1080')
    • revert_to_default : bool, optional
      • Revert to default item if no torrents are found (Default: False)
    • Returns the best torrent is json format
  • FUNCTION remove_cam_torrents

    • torrents : dict, required
      • The dictionary of torrents provided by the API (get_show or get_movie)
    • Returns all the torrents without cam in json format

Legal Notice

This SDK is not meant to be used for illegal purposes, use it at your own risk and check your local regulations first.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.