Metadata-Version: 2.1
Name: Ban-Peers
Version: 0.6.0
Summary: Checking & banning BitTorrent leech peers via Web API, remove ads, working for μTorrent.
Home-page: https://github.com/SeaHOH/ban-peers
Author: SeaHOH
Author-email: seahoh@gmail.com
License: MIT
Description: # Ban-Peers (English/[中文](https://github.com/SeaHOH/ban-peers/blob/master/README_zh.md))
        [![release status](https://img.shields.io/github/v/release/SeaHOH/ban-peers?include_prereleases&sort=semver)](https://github.com/SeaHOH/ban-peers/releases)
        [![code size](https://img.shields.io/github/languages/code-size/SeaHOH/ban-peers)](https://github.com/SeaHOH/ban-peers)
        
        Ban-Peers wrote in Python, it is checking & banning BitTorrent leech peers via Web API, remove ads, working for μTorrent. The main banned are XunLei, Baidu, QQDownload, Offline download servers, other infamous leech clients, and BT players, fake clients, who reported fake progress, the fact in serious leech.
        
        Execute checking per 10 seconds, the banned time can be specified by the start-up parameters, default is 12 hours. In some cases，only banned for 1 hour if the torrent is seeding. At the same time, this script will not broke the existing IP ranges (non-single IP) in ipfilter, they will be stored as-is.
        
        [A gift](https://github.com/SeaHOH/ban-peers/issues/1) to the users of μTorrent 3 classic desktop free version, it wrote in Chinese, you can read via a translator. e.g. translate.google.com
        
        Resist leech strongly, this is our own rights. If you feels Ban-Peers a good work, please recommend it to your friends, Thanks.
        
        # Notices
        - Does not work in old versions of μTorrent which did not provided API `getpeers`.
        - **Please use this script in local network**, μTorrent Web API does not support HTTPS connections, it is not safe.
        - I took preventive measures, if you stiil found a normal peer has been banned, please tell us via [issues board](https://github.com/SeaHOH/ban-peers/issues).
        
        # Installation
        Install from 
        [![version](https://img.shields.io/pypi/v/ban-peers)](https://pypi.org/project/ban-peers/)
        [![package format](https://img.shields.io/pypi/format/ban-peers)](https://pypi.org/project/ban-peers/#files)
        [![monthly downloads](https://img.shields.io/pypi/dm/ban-peers)](https://pypi.org/project/ban-peers/#files)
        
            pip3 install ban-peers
        
        Or download and Install from source code
        
            python setup.py install
        
        # Compatibility
        - Python >= 3.6
        
        # Usage
        First, Web UI must be enabled in μTorrent settings; then running Ban-Peers for specified ipfilter.dat file.
        
        Setting file ipfilter.dat, it is generally located in the path corresponding to the following cases.
        ```
        Mac:
                ~/Library/Application Support/uTorrent
                or
                /Applications/uTorrent.app/Contents/MacOS
        Unix utserver:
                use utserver argument "-settingspath" to specify settings folder path.
        Win XP:
                C:\Documents and Settings\<username>\Application Data\uTorrent
        Win 7 & above:
                C:\Users\<username>\AppData\Roaming\uTorrent
        Portable mode:
                μTorrent installation folder path. To enable this mode, first put file
                settings.dat into it.
        PortableApps:
                <PortableApps folder>\App\uTorrent
        Android:
                I don't know any informations about it, welcome to help add those informations,
                even Android is unavailable.
        Network File:
                run μTorrent at other machine, setup the settings folder as a network file path.
                e.g.
                NFS       mount –t nfs 192.168.1.20:/var/lib/utserver /mnt/utserver
                          /mnt/utserver
                SMB/CIFS  //machine1/share/uTorrent
        ```
        
        ```
        $ ban_peers -h
        Welcome using Ban-Peers 0.6.0
        
        Usage:
                ban_peers       [-H IP|DOMAIN] [-p PORT] [-a USERNAME:PASSWORD]
                                [-e HOURS] [-f FORMAT] [-C] [-X] [-P] [-L] [-R] [-U]
                                [-A] [-h] [-v] [IPFILTER-PATH]
        
        Checking & banning BitTorrent leech peers via Web API, remove ads, working for
        uTorrent.
        
        Positional Arguments:
                IPFILTER-PATH   Path of ipfilter dir/file, wait input if empty.
                                IMPORTANT NOTICE: must be the uTorrent settings path!
        
        Optional Arguments:
                -H IP|DOMAIN, --host IP|DOMAIN
                                WebUI host, default 127.0.0.1
                -p PORT, --port PORT
                                WebUI port, default 8080
                -a USERNAME:PASSWORD, --authorization USERNAME:PASSWORD
                                WebUI authorization, wait input if required
                -e HOURS, --expire HOURS
                                Ban expire time for peers, default 12 HOURS
                -f FORMAT, --log-header FORMAT
                                Format of log header, default %H:%M:%S
                -C, --resolve-country
                                Set uTorrent to resolved peer's country code at start-up
                -X, --no-xunlei-reprieve
                                Banned XunLei directly, no more checking
                -P, --no-fake-progress-check
                                Don't checking fake progress
                -L, --no-serious-leech-check
                                Don't checking serious leech
                -R, --private-check
                                Enable checking for private seeds
                -U, --log-unknown
                                Logging unknown clients
                -A, --remove-ads
                                Remove ads via set Advanced Settings, only working for localhost
                -h, --help      Show this help message and exit
                -v, --version   Show version and exit
        ```
        
        ```markdown
        $ ban_peers -p 12345 -a username:password /var/lib/utserver
        Welcome using Ban-Peers 0.6.0
        19:44:35 设定 uTorrent 配置 'gui.show_plus_upsell_nodes' 到 False  **_Remove upsell tip in the sidebar_**
        19:44:35 Set uTorrent setting 'bt.use_rangeblock' to False  **_Won't restore after quit_**
        19:44:35 uTorrent auto-banning script start running
        Choose your operation: (Q)uit, (S)top, (R)estart, (P)ause/Proceed
        ```
        
        or
        
        ```markdown
        $ ban-peers
        Welcome using Ban-Peers 0.6.0
        Please input uTorrent settings folder path or ipfilter file path:
        /var/lib/utserver
        Please input WebUI username: username
        Please input WebUI password: password  **_No cover_**
        19:44:35 设定 uTorrent 配置 'gui.show_plus_upsell_nodes' 到 False  **_Remove upsell tip in the sidebar_**
        19:44:35 Set uTorrent setting 'bt.use_rangeblock' to False  **_Won't restore after quit_**
        19:44:35 uTorrent auto-banning script start running
        Choose your operation: (Q)uit, (S)top, (R)estart, (P)ause/Proceed
        ```
        
        - Quit: exit the script.
        - Stop: stop checking if run script via import as package, or same as Quit.
        - Restart: reload ipfilter.dat, it is useful when manually modify ipfilter.dat.
        - Pause: pause checking, it is useful when manually modify ipfilter.dat.
        - Proceed: just proceed checking.
        
        # Got troubles/ideas
        Visit the [issues board](https://github.com/SeaHOH/ban-peers/issues) and post them, maybe someone can help you.
        
        # Related projects
        - μTorrent
        
            https://github.com/ShenHongFei/utorrent-block-xunlei  
            https://github.com/iHamsterball/utorrent_block_thunder  
        
        - qBittorrent
        
            https://github.com/c0re100/qBittorrent-Enhanced-Edition  
            https://github.com/originqtum/banned-xunlei-for-qbittorrent  
            https://github.com/jinliming2/qbittorrent-ban-xunlei  
            https://github.com/Od1gree/btDownloadManager  
            https://github.com/outline941/qb-ban-xunlei  
        
        # Thanks
        [c0re100](https://github.com/c0re100/qBittorrent-Enhanced-Edition)  
        [ShenHongFei](https://github.com/ShenHongFei/utorrent-block-xunlei)  
        
        # License
        Ban-Peers is released under the [![license](https://img.shields.io/github/license/SeaHOH/ban-peers)](https://github.com/SeaHOH/ban-peers/blob/master/LICENSE).
        
Keywords: BitTorrent uTorrent anti-leech ban block XunLei anti-ads
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
