Skip to content

Commit

Permalink
Remake docs & increment version
Browse files Browse the repository at this point in the history
  • Loading branch information
@HarryShomer
HarryShomer committed Jan 12, 2021
1 parent a95f990 commit 35e6156
Show file tree
Hide file tree
Showing 19 changed files with 66 additions and 72 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ v1.37
-----
* Now saves scraped pages in docs_dir as a GZIP
* Only print full error summary when the number of games scraped is >= 25
* Remove hardcoded exception for Sebastian Aho. Updated process to work without it.
36 changes: 0 additions & 36 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,42 +198,6 @@ Here is a simple example of a way to setup live scraping. I strongly suggest che



.. NWHL Usage
.. -------------
.. Scrape data on a season by season level:
.. ::

import hockey_scraper

# Scrapes the 2015 & 2016 season and stores the data in a Csv file
hockey_scraper.nwhl.scrape_seasons([2015, 2016])

# 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:
.. ::

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:
.. ::

import hockey_scraper

# Scrapes all games between 2016-10-10 and 2017-01-01 and returns a Pandas DataFrame containing the pbp
hockey_scraper.nwhl.scrape_date_range('2016-10-10', '2017-01-01', data_format='pandas')



Contact
-------

Expand Down
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d045b995c298b5874c5978582a74f44d
config: 884598b000d9ad95ebcd057655b12fa7
tags: 645f666f9bcd5a90fca523b33c5a78b7
28 changes: 25 additions & 3 deletions docs/build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; hockey_scraper 1.36 documentation</title>
<title>Index &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand All @@ -25,7 +25,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down Expand Up @@ -53,6 +53,7 @@ <h1 id="index">Index</h1>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
| <a href="#V"><strong>V</strong></a>

</div>
<h2 id="A">A</h2>
Expand Down Expand Up @@ -229,6 +230,13 @@ <h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
hockey_scraper.cli

<ul>
<li><a href="cli.html#module-hockey_scraper.cli">module</a>
</li>
</ul></li>
<li>
hockey_scraper.nhl.game_scraper

<ul>
Expand Down Expand Up @@ -352,6 +360,8 @@ <h2 id="M">M</h2>
module

<ul>
<li><a href="cli.html#module-hockey_scraper.cli">hockey_scraper.cli</a>
</li>
<li><a href="nhl_scrape_functions.html#module-hockey_scraper.nhl.game_scraper">hockey_scraper.nhl.game_scraper</a>
</li>
<li><a href="nhl_scrape_functions.html#module-hockey_scraper.nhl.json_schedule">hockey_scraper.nhl.json_schedule</a>
Expand Down Expand Up @@ -436,6 +446,10 @@ <h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="nhl_scrape_functions.html#hockey_scraper.nhl.pbp.html_pbp.return_name_html">return_name_html() (in module hockey_scraper.nhl.pbp.html_pbp)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cli.html#hockey_scraper.cli.run_cmd">run_cmd() (in module hockey_scraper.cli)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -532,6 +546,14 @@ <h2 id="U">U</h2>
</ul></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cli.html#hockey_scraper.cli.validate_args">validate_args() (in module hockey_scraper.cli)</a>
</li>
</ul></td>
</tr></table>



<div class="clearer"></div>
Expand Down Expand Up @@ -563,7 +585,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Hockey-Scraper &#8212; hockey_scraper 1.36 documentation</title>
<title>Hockey-Scraper &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand All @@ -29,7 +29,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="nhl_scrape_functions.html" title="NHL Scraping Functions"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Hockey-Scraper</a></li>
</ul>
</div>
Expand Down Expand Up @@ -280,7 +280,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="nhl_scrape_functions.html" title="NHL Scraping Functions"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Hockey-Scraper</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/license_link.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>License &#8212; hockey_scraper 1.36 documentation</title>
<title>License &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand All @@ -29,7 +29,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="live_scrape.html" title="Live Scraping"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">License</a></li>
</ul>
</div>
Expand Down Expand Up @@ -849,7 +849,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="live_scrape.html" title="Live Scraping"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">License</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/live_scrape.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Live Scraping &#8212; hockey_scraper 1.36 documentation</title>
<title>Live Scraping &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -33,7 +33,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="nhl_scrape_functions.html" title="NHL Scraping Functions"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Live Scraping</a></li>
</ul>
</div>
Expand Down Expand Up @@ -548,7 +548,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="nhl_scrape_functions.html" title="NHL Scraping Functions"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Live Scraping</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/nhl_scrape_functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>NHL Scraping Functions &#8212; hockey_scraper 1.36 documentation</title>
<title>NHL Scraping Functions &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -33,7 +33,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="Hockey-Scraper"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">NHL Scraping Functions</a></li>
</ul>
</div>
Expand Down Expand Up @@ -2042,7 +2042,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="Hockey-Scraper"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">NHL Scraping Functions</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/nwhl_scrape_functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>NWHL Scraping Functions &#8212; hockey_scraper 1.36 documentation</title>
<title>NWHL Scraping Functions &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand All @@ -25,7 +25,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">NWHL Scraping Functions</a></li>
</ul>
</div>
Expand Down Expand Up @@ -134,7 +134,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">NWHL Scraping Functions</a></li>
</ul>
</div>
Expand Down
Binary file modified docs/build/html/objects.inv
View file
Binary file not shown.
11 changes: 8 additions & 3 deletions docs/build/html/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &#8212; hockey_scraper 1.36 documentation</title>
<title>Python Module Index &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand All @@ -28,7 +28,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
</ul>
</div>
Expand All @@ -55,6 +55,11 @@ <h1>Python Module Index</h1>
<td>
<code class="xref">hockey_scraper</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="cli.html#module-hockey_scraper.cli"><code class="xref">hockey_scraper.cli</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
Expand Down Expand Up @@ -147,7 +152,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; hockey_scraper 1.36 documentation</title>
<title>Search &#8212; hockey_scraper 1.37.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nature.css" type="text/css" />

Expand All @@ -30,7 +30,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
Expand Down Expand Up @@ -81,7 +81,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.36 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">hockey_scraper 1.37.3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
# built documents.
#
# The short X.Y version.
version = '1.36'
version = '1.37.3'
# The full version, including alpha/beta/rc tags.
release = '1.36'
release = '1.37.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
3 changes: 1 addition & 2 deletions hockey_scraper/nhl/scrape_functions.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,7 @@ def scrape_schedule(from_date, to_date, data_format='pandas', rescrape=False, do
return sched_df


def scrape_date_range(from_date, to_date, if_scrape_shifts, data_format='csv', preseason=False, rescrape=False,
docs_dir=False):
def scrape_date_range(from_date, to_date, if_scrape_shifts, data_format='csv', preseason=False, rescrape=False, docs_dir=False):
"""
Scrape games in given date range
Expand Down
3 changes: 1 addition & 2 deletions hockey_scraper/utils/shared.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def print_error(msg):
ansi_red_code = '\033[0;31m'
warning_msg = "{}Error: {}".format(ansi_red_code, msg)

warnings.warn(warning_msg)
warnings.warn(warning_msg)


def print_warning(msg):
Expand All @@ -198,7 +198,6 @@ def print_warning(msg):
warnings.warn(warning_msg)



def get_season(date):
"""
Get Season based on from_date
Expand Down

0 comments on commit 35e6156

Please sign in to comment.