/TeamCowboyApi-Python

Python Wrapper for the Team Cowboy api

Primary LanguagePythonMIT LicenseMIT

Team Cowboy API Python

The Unofficial Python Wrapper for the Team Cowboy API

PyPI version Main Branch Status PyPI - Python Version GitHub

Team Cowboy API

Getting Started

TeamCowboyApi-Python is a Python library that provides developers with access to the Team Cowboy API which allows developers to retrieve information related to teams, players, events, and more. TeamCowboyApi-Python written in python 3.10+.

To get started with the library, refer to the information provided in this README. For a more detailed explanation, check out the documentation and the Wiki section. The Wiki contains information on return objects, endpoint structure, usage examples, and more. It is a valuable resource for getting started, working with the library, and finding the information you need. You can also visit Team Cowboys official api documentation here and apply for api access here

Docs | Examples | Wiki | API

Installation

python3 -m pip install python-teamcowboy-api

Usage

python3
>>> import teamcowboyapi
>>> Teamcowboy = teamcowboyapi.Teamcowboy(privateapikey, publicapikey, username, password)
>>> Teamcowboy.Event_Get(teamid, eventid)

Documentation

Authentication Methods

  • Teamcowboy.Auth_GetUserToken(self, username: str, password: str) - Return user auth token

Event Methods

  • Teamcowboy.Event_Get(self, teamId: int, eventId: int, **params) - Return Event from teamid and eventid
  • Teamcowboy.Event_GetAttendanceList(self, teamId: int, eventId: int) - Return Attendance List from teamid and eventid
  • Teamcowboy.Event_SaveRSVP(self, teamId: int, eventId: int, status: str, **params) - Save RSVP from teamid eventid and rsvp status

Message Methods

  • Teamcowboy.Message_Get(self, teamId: int, messageId: int, **params) - Return Message from teamid and messageid
  • Teamcowboy.Message_Delete(self, teamId: int, messageId: int) - Delete Message from teamid and messageid
  • Teamcowboy.Message_Save(self, teamId: int, title: str, body: str, **params) - Save Message from teamid and messageid
  • Teamcowboy.MessageComment_Delete(self, teamId: int, messageId: int, commentId: int) - Delete Message comment from teamid and messageid and comment
  • Teamcowboy.MessageComment_Add(self, teamId: int, messageId: int, comment: str) - Add Message comment from teamid and messageid and comment

Team Methods

  • Teamcowboy.Team_Get(self, teamId: int) - Return Team from teamid
  • Teamcowboy.Team_GetEvents(self, teamId: int, **params) - Return team Events from teamid
  • Teamcowboy.Team_GetMessages(self, teamId: int, **params) - Return team Messages from teamid
  • Teamcowboy.Team_GetRoster(self, teamId: int, **params) - Return team Roster from teamid
  • Teamcowboy.Team_GetSeasons(self, teamId: int) - Return team Seasons from teamid

Test Methods

  • Teamcowboy.Test_GetRequest(self, **params) - Test api's GET
  • Teamcowboy.Test_PostRequest(self, **params) - Test api's POST

User Methods

  • Teamcowboy.User_Get(self) - Return User
  • Teamcowboy.User_GetNextTeamEvent(self, **params) - Return next team Event for user
  • Teamcowboy.User_GetTeamEvents(self, **params) - Return next team Events for user
  • Teamcowboy.User_GetTeamMessages(self, **params) - Return team Messages for user
  • Teamcowboy.User_GetTeams(self, **params) - Return users Teams