Skip to content

Commit f90ade9

Browse files
committed
Updates:
- Adds README.md with setup instructions and copy. Fixes build pipeline with correct package name
1 parent 9df7a61 commit f90ade9

2 files changed

Lines changed: 46 additions & 3 deletions

File tree

.github/workflows/python-app.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will install Python dependencies, run tests and lint with a single version of Python
22
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
33

4-
name: NHL-API-PY
4+
name: Data-Golf-API
55

66
on:
77
push:

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
1-
# data-golf-api
2-
API Library for DataGolf.com APIs
1+
[![Data-Golf-API](https://github.com/coreyjs/data-golf-api/actions/workflows/python-app.yml/badge.svg)](https://github.com/coreyjs/data-golf-api/actions/workflows/python-app.yml)
2+
[![PyPI version](https://badge.fury.io/py/data_golf.svg)](https://badge.fury.io/py/data_golf)
3+
4+
5+
# Data_Golf
6+
7+
### An Unofficial API Library for DataGolf.com APIs
8+
9+
This is a Python library for interacting with the DataGolf APIs. DataGolf is a golf analytics platform that provides a wide range of data and analytics for golf tournaments, players, and courses.
10+
11+
**This is an unofficial API lib, and it is not affiliated with DataGolf in any way.**
12+
13+
14+
This is being built to support some ML projects I am working on. I will be
15+
continuing to add more endpoints as I need them. If you have a specific endpoint you need, please open a ticket for submit a PR.
16+
17+
18+
19+
---
20+
# Usage
21+
(Currently this only supports JSON formats, CSV is in progress)
22+
23+
```python
24+
pip install data_golf
25+
```
26+
27+
```python
28+
from data_golf import DataGolfClient
29+
30+
client = DataGolfClient(api_key="YOUR_API_KEY")
31+
32+
# For more request logging
33+
client = DataGolfClient(api_key="YOUR_API_KEY", verbose=True)
34+
```
35+
36+
37+
# General APIs
38+
39+
```python
40+
# Player List
41+
players = client.general.player_list()
42+
43+
# Tour Schedule
44+
tour_schedule = client.general.tour_schedule()
45+
```

0 commit comments

Comments
 (0)