asc/pyteamsnap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README fixes

Browse Source
This commit is contained in:
Anthony Correa
2022-05-22 16:34:15 -05:00
parent 6dceb2d692
commit 8f6ad30acf
1 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -108,40 +108,40 @@ An unoffical python wrapper for the [TeamSnap API](https://www.teamsnap.com/docu
## Usage Example ## Usage Example
```python ```python
from pyteamsnap.api import TeamSnap, Me, Event, EventLineupEntries, Member from pyteamsnap.api import TeamSnap, Me, Event, EventLineupEntry, Member
client = TeamSnap(token=TOKEN) client = TeamSnap(token=TOKEN)
# get authenticated user # get authenticated user
me = Me(client) me = Me(client)
# get a list of team_ids for the user # get a list of team_ids for the user
managed_team_ids = me.data['managed_teams'] managed_team_ids = me.data['managed_teams']
# get a list of events for managed team # get a list of events for managed team
managed_team_id = me.data['managed_teams'][0] managed_team_id = me.data['managed_teams'][0]
events = Event.search(client, team_id=managed_team_id) events = Event.search(client, team_id=managed_team_id)
# get an object with the object id of EVENT_ID # get an object with the object id of EVENT_ID
event = Event.get(client, id=EVENT_ID) event = Event.get(client, id=EVENT_ID)
# get some information about the event # get some information about the event
start_date = event.data['start_date'] start_date = event.data['start_date']
# create a new member # create a new member
member = Member.new(client) member = Member.new(client)
member.data['first_name'] = 'Ferguson' member.data['first_name'] = 'Ferguson'
member.post() member.post()
# update a Member with id of MEMBER_ID # update a Member with id of MEMBER_ID
member = Member.get(client, id=MEMBER_ID) member = Member.get(client, id=MEMBER_ID)
member.data['last_name'] = 'Jenkins' member.data['last_name'] = 'Jenkins'
member.put() member.put()
# delete a Member # delete a Member
member.delete() member.delete()
# perform a bulk load # perform a bulk load
list_of_ts_objects = client.bulk_load(team_id = TEAM_ID, types = [Event, Member], event__id=EVENT_ID) list_of_ts_objects = client.bulk_load(team_id = TEAM_ID, types = [Event, Member], event__id=EVENT_ID)
``` ```