Metadata-Version: 2.1
Name: pyIPRoyalPawns
Version: 0.2.2
Summary: UNOFFICIAL Python bindings for IPRoyal Pawns Dashboard API
Home-page: https://github.com/coder-amogh/pyIPRoyalPawns
Author: coder-amogh (Amogh Datar)
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/coder-amogh/pyIPRoyalPawns/issues
Description: 
        # IPRoyal Pawns API
        
        UNOFFICIAL Python bindings for IPRoyal Pawns Dashboard API
        
        ## Installation
        
        ```BASH
        pip install pyIPRoyalPawns
        ```
        
        ## Usage
        
        ---
        
        ### Login with username and password:
        
        ```PYTHON
        from pyIPRoyalPawns import IPRoyalPawns
        
        # Your IPRoyalPawns (IPR) login username/email and password
        USERNAME = ""
        PASSWORD = ""
        
        # Initialise the HoneyGain object
        user = IPRoyalPawns()
        
        # Optionally, when instantiating you can pass in the following attributes to the IPRoyalPawns class:
        ```
        
        | Attribute      | Description        | Default Value                   |
        |----------------|--------------------|---------------------------------|
        | API_BASE_URL | The API BASE URL | https://pawns.iproyal.com                            |
        
        ```PYTHON
        # Call the login method
        user.login(USERNAME, PASSWORD)
        ```
        
        ---
        
        ### Add proxies for future requests:
        
        ```PYTHON
        from pyIPRoyalPawns import IPRoyalPawns
        
        # With authentication
        user.set_proxy("ip:port:username:password")
        
        # Without authentication
        user.set_proxy("ip:port")
        ```
        
        ## Functions
        
        ---
        
        1. Get user dashboard
        
            ```PYTHON
            user.dashboard()
            ```
        ---
        
        2. Remove a proxy
        
            ```PYTHON
            # Removes a proxy for future requests.
            user.remove_proxy()
            ```
        ---
        
        3. Get all the devices
        
            ```PYTHON
            # Get all the devices shown on dashboard
            user.devices()
            ```
        ---
        
        ## Exceptions
        
        - The following exceptions are defined.
            Exception | Reason
            --- | ---
            `NotLoggedInError` | Raised when you try to access protected routes (dashboard, payout history, etc).
            `HTMLWebpageParserError` | Raised when the webpage parser cannot parse the response of the dashboard request (typically when you're rate limited or a broken connection)
        
        ---
        
        ## Liked my work?
        
        ---
        
        Consider donating:
        
        - BTC: bc1q5y8z0cpgvafedvmwcfjn682skpr67e2du00acy
        
        - LTC: LcquWHprnVRHY86u5rNDW6U8VD3WVbZV4h
        
        
Keywords: python,iproyal,ipr,passive income,iproyal pawns api,iproyal pawns dashboard,python iproyal pawns
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
