Metadata-Version: 2.1
Name: the-python-bay
Version: 1.1.3
Summary: A simple package for searching thepiratebay.org
Home-page: https://github.com/philhabell/the-python-bay
Author: Phil Bell
Author-email: philhabell@gmail.com
License: UNKNOWN
Description: [![title](https://img.shields.io/pypi/v/the-python-bay.svg)](https://pypi.org/project/the-python-bay)
        [![title](https://img.shields.io/pypi/pyversions/the-python-bay.svg)](https://pypi.org/project/the-python-bay)
        
        
        
        
        # the-python-bay
        
        Python library for searching thepiratebay.org
        
        ## Install
        
            pip install the-python-bay
        
        ## Basic Usage
        
        ```
        from the_python_bay import tpb
        
        results = tpb.search("ubuntu")
        ```
        
        This will return the a list of instances of the `Torrent` class.
        
        So you can then access the data like so:
        ```
        for torrent in results:
            print(f"{torrent.name} - {torrent.magnet}")
        ```
        
        ## Full Docs
        ### search
        This can be used to search thepiratebay.org, it will return a list of instances of the `Torrent` class.
        ```python
        from the_python_bay import tpb
        results = tpb.search("ubuntu")
        ```
        
        ### top_movies
        Can be used to return the current top 100 movies on thepiratebay.org
        ```python
        from the_python_bay import tpb
        results = tpb.top_movies()
        ```
        
        ### top_tv
        Can be used to return the current top 100 tv on thepiratebay.org
        ```python
        from the_python_bay import tpb
        results = tpb.top_tv()
        ```
        
        ### Torrent
        The `Torrent` class is the format the torrents are returned in, it has the following attributes:
        - `name`     the torrents name
        - `magent`   the torrents magnet link
        - `seeders`  number of seeders the torrent has
        - `username` the username of the torrents uploader
        - `status`   the users prominence status
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
