Skip to content

Commit

Permalink
updated readme to reflect nwhl changes
Browse files Browse the repository at this point in the history
  • Loading branch information
HarryShomer committed Sep 29, 2019
1 parent 3d636ac commit 1f227f2
Showing 1 changed file with 12 additions and 18 deletions.
30 changes: 12 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Hockey-Scraper
.. inclusion-marker-for-sphinx
**Note: Due to changes in the NHL API and ESPN's website, coordinates are only scraped when using version 1.33 and higher.**
**Notes:**
* Coordinates are only scraped from ESPN for versions 1.33+
* NWHL usage has been deprecated due to the removal of the pbp information for each game.


Purpose
Expand Down Expand Up @@ -177,12 +179,13 @@ Here is a simple example of a way to setup live scraping. I strongly suggest che
to_csv(game)


NWHL Usage

.. NWHL Usage
----------

Scrape data on a season by season level:
.. Scrape data on a season by season level:
::
.. ::

import hockey_scraper

Expand All @@ -192,19 +195,19 @@ Scrape data on a season by season level:
# Scrapes the 2008 season and returns a Pandas DataFrame containing the pbp
scraped_data = hockey_scraper.nwhl.scrape_seasons([2017], data_format='Pandas')

Scrape a list of games:
.. Scrape a list of games:
::
.. ::

import hockey_scraper

# Scrape some games and store the results in a Csv file
# Also saves the scraped pages
hockey_scraper.nwhl.scrape_games([14694271, 14814946, 14689491], docs_dir="...Path you specified")

Scrape all games in a given date range:
.. Scrape all games in a given date range:
::
.. ::

import hockey_scraper

Expand All @@ -219,13 +222,4 @@ Contact
-------

Please contact me for any issues or suggestions. For any bugs or anything related to the code please open an issue.
Otherwise you can email me at Harryshomer@gmail.com.









Otherwise you can email me at Harryshomer@gmail.com.

0 comments on commit 1f227f2

Please sign in to comment.