Metadata-Version: 2.1
Name: yahoo_earnings_calendar
Version: 0.5.1
Summary: Scrapes data from Yahoo! Finance earnings calendar
Home-page: https://github.com/wenboyu2/yahoo-earnings-calendar
Author: Wenbo Yu
Author-email: wenboyu2@gmail.com
License: UNKNOWN
Description: # Yahoo! Earnings Calendar Scraper
        [![codecov](https://codecov.io/gh/wenboyu2/yahoo-earnings-calendar/branch/master/graph/badge.svg)](https://codecov.io/gh/wenboyu2/yahoo-earnings-calendar)
        [![Build Status](https://travis-ci.com/wenboyu2/yahoo-earnings-calendar.svg?branch=master)](https://travis-ci.com/wenboyu2/yahoo-earnings-calendar)
        
        Scrapes Yahoo! Finance earnings calendar to get data for a specific date or a date range.
        
        ## Installation
        ### Pip
        ```sh
        pip install yahoo_earnings_calendar
        ```
        
        ## Usage
        
        ### Get earnings date information on a specific date or in a date range
        ```python
        import datetime
        from yahoo_earnings_calendar import YahooEarningsCalendar
        
        date_from = datetime.datetime.strptime(
            'May 5 2017  10:00AM', '%b %d %Y %I:%M%p')
        date_to = datetime.datetime.strptime(
            'May 8 2017  1:00PM', '%b %d %Y %I:%M%p')
        yec = YahooEarningsCalendar()
        print(yec.earnings_on(date_from))
        print(yec.earnings_between(date_from, date_to))
        ```
        
        #### Data attributes
        - companyshortname: Company Name
          - e.g., 20160606
        - ticker: Ticker
          - e.g., AAPL
        - startdatetime: Event Start Time
          - e.g., 2017-04-23T21:00:00.000-04:00
        - startdatetimetype: Event Start Time Type
          - e.g., TAS (Time Not Supplied), AMC (After Market Close	)
        - epsestimate: EPS Estimate
        - epsactual: Reported EPS
        - epssurprisepct: Surprise (%)
        - gmtOffsetMilliSeconds: GMT Offset in MS
        
        ### Get the next earnings date of a specific symbol
        ```python
        import datetime
        from yahoo_earnings_calendar import YahooEarningsCalendar
        
        yec = YahooEarningsCalendar()
        # Returns the next earnings date of BOX in Unix timestamp
        print(yec.get_next_earnings_date('box'))
        # 1508716800
        ```
        
        ### Set delay between requests
        
        By default, requests are delayed by 1.8 sec to avoid exceeding the 2000/hour rate limit. You can override the default delay by passing an argument to the `YahooEarningsCalendar` constructor.
        
        ```py
        import datetime
        from yahoo_earnings_calendar import YahooEarningsCalendar
        
        my_custom_delay_s = 0.5
        
        yec = YahooEarningsCalendar(my_custom_delay_s)
        ```
        
Keywords: stock,earnings,yahoo,scrape,finance
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
