Skip to content

Commit

Permalink
made small changes to examples
Browse files Browse the repository at this point in the history
  • Loading branch information
erin2722 committed May 8, 2023
1 parent acb5e11 commit 4577223
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 687 deletions.
19 changes: 19 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@ usau-scraper documentation
modules
developer

Overview
===================================
USAU (USA Ultimate) is the governing body of ultimate frisbee, and its website (which is notoriously hard to navigate)
contains all of the information about high school, college, and club ultimate frisbee teams. Right now, there is no easy
way to access this data. USAU scraper solves this problem by scraping the USAU website for data and therefore allowing
other developers to easily use the data on the USAU site. This project will open the door to more data analytic projects
concerning ultimate frisbee.

usau-scraper allows developers to easily access:
* Team roster, schedule, and results data.
* Tournament results data, from all pool play results to just the first and second place winners of the tournament.
* Rankings data for the college and club levels.

Installation
===================================
:code:`pip install --upgrade usau-scraper`
Expand Down Expand Up @@ -68,6 +81,12 @@ After :code:`pip install --upgrade usau-scraper` in your python env:
# Get the top 20 women's club teams
print(getClubRankings(genderDivision="Women"))

# Print the schedule for each top 20 team
teams = getCollegeRankings(genderDivision="Women")["teams"]

for team in teams:
print(json.dumps(getTeamSchedule(schoolName=team["Team"], genderDivision='Women', competitionLevel='College')["teams"][0], indent=4))

Additional usage examples are `in this notebook <https://colab.research.google.com/github/erin2722/usau-scraper/blob/main/examples/usau_scraper_example.ipynb#scrollTo=rEfGbe_ruqk4>`_.

Indices and tables
Expand Down
Loading

0 comments on commit 4577223

Please sign in to comment.