diff options
| author | Rasmus Luha <rasmus.luha@gmail.com> | 2022-03-17 19:04:59 +0200 |
|---|---|---|
| committer | Rasmus Luha <rasmus.luha@gmail.com> | 2022-03-17 19:04:59 +0200 |
| commit | aba5fe2805cd90048774994d4b1d11baf1319f6e (patch) | |
| tree | fe7eae976c678c6526fe521071eb4c7a8aaa3b44 /README.md | |
| parent | 76350412051aed8af69b5f797e157679f7b8a698 (diff) | |
README cleanup
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -1,6 +1,7 @@ # Overview This project has the functionality to fetch data about NBA and store it in csv format files. -It also has an API to serve the data. API can be accessed [here](https://luhamus-nba-data.herokuapp.com/). +It also has an API to serve the data. +API is at this [url](https://luhamus-nba-data.herokuapp.com/). ## How to use ### API @@ -14,12 +15,12 @@ or just use [this](https://luhamus-nba-data.herokuapp.com/teams). * For player information, the endpoint is "/players/{team_name} - you can get the team name from fetching the teams data. ''' - https//:{api_url}/players/{team_name} + {api_url}/players/{team_name} ''' - Examples with Bulls, Celtics, Hawks: - * [this](https://luhamus-nba-data.herokuapp.com/teams/bulls). - * [this](https://luhamus-nba-data.herokuapp.com/teams/celtics). - * [this](https://luhamus-nba-data.herokuapp.com/teams/hawks). + * [https://luhamus-nba-data.herokuapp.com/teams/bulls](https://luhamus-nba-data.herokuapp.com/teams/bulls). + * [https://luhamus-nba-data.herokuapp.com/teams/celtics](https://luhamus-nba-data.herokuapp.com/teams/celtics). + * [https://luhamus-nba-data.herokuapp.com/teams/hawks](https://luhamus-nba-data.herokuapp.com/teams/hawks). - NB: you shouldn't use the "full_name", like "Chicago Bulls". ### Fetching Data @@ -27,7 +28,6 @@ Code for fetching data in in directory AllAboutData, where the fetched data will also be stored. To use the data fetching script, you should clone the repo and do following: ```bash -git clone {repo} cd {cloned_repo_name} python -m venv venv source venv/bin/activate @@ -42,7 +42,7 @@ and add your api key there like this. API_KEY = {your_api_key} ``` You can get yourself the api key from this [link](https://rapidapi.com/theapiguy/api/free-nba/). -Once you have done that you can use the script. +You have to subscribe to the API, but it is free. Once you have done that you can use the script. ```bash cd AllAboutData python getData.py |