Metadata-Version: 2.1
Name: auroraplus
Version: 1.1.3
Summary: Python library to access the Aurora+ API: https://api.auroraenergy.com.au/api
Home-page: https://github.com/leighcurran/AuroraPlus
Author: Leigh Curran
Author-email: AuroraPlusPy@outlook.com
License: MIT
Description: AuroraPlus is a package to pull data from https://api.auroraenergy.com.au/api. To use the Aurora+ API you need a valid account with Aurora.
        
        ## Requirements
        - Install Python 3.9 (for all users)
        - Pip install requests
        
        ## Usage
        
        Connect to Aurora+ API:
        
            import auroraplus
            AuroraPlus = auroraplus.api()
            AuroraPlus.auth("user.name@outlook.com", "password")
          
        
        To get current account information use the following:
        
            AuroraPlus.getcurrent()
        
        getcurrent() gets the following data:
        
            EstimatedBalance - This is shown in the Aurora+ app as 'Balance'
            UsageDaysRemaining - This is shown in the Aurora+ app as 'Days Prepaid'
            AverageDailyUsage
            AmountOwed
            ActualBalance
            UnbilledAmount
            BillTotalAmount
            NumberOfUnpaidBills
            BillOverDueAmount
            
            Note: All data except AverageDailyUsage is updated Daily.
        
        An example getting specific data with getcurrent:
        
            import auroraplus
            AuroraPlus = auroraplus.api()
            AuroraPlus.auth("user.name@outlook.com", "password")
            if (not AuroraPlus.Error):
                AuroraPlus.getcurrent()
                print(AuroraPlus.AmountOwed)
            else:
                print(AuroraPlus.Error)
                
        To get summary usage information use the following:
        
            AuroraPlus.getsummary()
            
            Note: This returns two collections, DollarValueUsage and KilowattHourUsage.
            
        An example getting specific data with getsummary:
        
            import auroraplus
            AuroraPlus = auroraplus.api()
            AuroraPlus.auth("user.name@outlook.com", "password")
            if (not AuroraPlus.Error):
                AuroraPlus.getsummary()
                print(AuroraPlus.DollarValueUsage['T41'])
                print(AuroraPlus.DollarValueUsage['T31'])
                print(AuroraPlus.DollarValueUsage['Other'])
                print(AuroraPlus.DollarValueUsage['Total'])
                print(AuroraPlus.KilowattHourUsage['T41'])
                print(AuroraPlus.KilowattHourUsage['T31'])
                print(AuroraPlus.KilowattHourUsage['Total'])
            else:
                print(AuroraPlus.Error)
                
            Note: Offpeak tarrifs not listed
        
        To get usage data use the following, this returns all available data in json format for each timespan:
        
            AuroraPlus.getday()
            AuroraPlus.getweek()
            AuroraPlus.getmonth()
            AuroraPlus.getquarter()
            AuroraPlus.getyear()
        
        Full example:
        
            import auroraplus
            AuroraPlus = auroraplus.api()
            AuroraPlus.auth("user.name@outlook.com", "password")
            if (not AuroraPlus.Error):
                AuroraPlus.getcurrent()
                print(AuroraPlus.AmountOwed)
                
                AuroraPlus.getday()
                print(AuroraPlus.day)
                
                AuroraPlus.getweek()
                print(AuroraPlus.week)
                
                AuroraPlus.getmonth()
                print(AuroraPlus.month
                
                AuroraPlus.getyear()
                print(AuroraPlus.year)
            else:
                print(AuroraPlus.Error)
Keywords: Aurora+,AuroraPlus,Aurora,Tasmania,API
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
