Skip to content

Latest commit

 

History

History
902 lines (833 loc) · 23.1 KB

README.md

File metadata and controls

902 lines (833 loc) · 23.1 KB
Raw

smashggpy

smashggpy is an SDK that wraps around the public smash.gg GraphQL API. It implements a series of easy to use objects, and features a background thread which manages outstanding queries to handle GraphQL's Rate Limiting feature.

Getting Started

from smashggpy.models.Event import Event
from smashggpy.util import Initializer
from smashggpy.util.QueryQueueDaemon import QueryQueueDaemon

if __name__ == '__main__':
    Initializer.initialize('API_KEY', 'info')
    to12_melee = Event.get('tipped-off-12-presented-by-the-lab-gaming-center', 'melee-singles')
    sets = to12_melee.get_sets()
    for ggset in sets:
        print("{0}: {1} {2} - {3} {4}".format(
            ggset.full_round_text,
            ggset.player1,
            ggset.score1,
            ggset.score2,
            ggset.player2)
        )

    QueryQueueDaemon.kill_daemon()

This results in the following:

Winners Final: MVG FOX | Mew2King 2 - 0 OeS | NIX
Losers Semi-Final: Gas$ 0 - 2 bobby big ballz
Winners Semi-Final: MVG FOX | Mew2King 2 - 0 Gas$
Winners Semi-Final: OeS | NIX 2 - 0 bobby big ballz
Losers Quarter-Final: bobby big ballz 2 - 0 DarkGenex
Losers Quarter-Final: Gas$ 2 - 0 Cynax
Losers Round 3: Greenmario 1 - 2 Cynax
Losers Round 3: DarkGenex 2 - 0 CV | Cloud-9
....

Docs

Initializer

Methods

  • initialize(api_key [, log_level])
    • initialize the SDK
    • parameters
      • api_key
        • string
        • the api key to access the smash.gg API
      • optional: log_level
        • string
        • log level for the built-in logger
        • allowed values:
          • 'critical'
          • 'error'
          • 'warning'
          • 'info'
          • 'debug'

QueryQueueDaemon

Methods

  • kill_daemon()
    • ends the parallel thread that is monitoring the QueryQueue
    • NOTE call this if you need your program to terminate, otherwise ignore

Tournament

Properties

  • id
    • int
    • id of the tournament object
  • name
    • string
    • name of the tournament
  • slug
    • string
    • url slug of the tournament
  • start_time
    • int
    • unix epoch of the tournament start time
  • end_time
    • int
    • unix epoch of the tournament end time
  • timezone
    • string
    • timezone the tournament took place in
  • venue
  • organizer

Methods

Static
  • get(tournament_slug)
    • get tournament data from smashgg for the corresponding tournament slug
    • parameters
      • tournament_slug
        • string
        • long-name slug for a tournament
          • function-3-recursion-series
          • tipped-off-12-presented-by-the-lab-gaming-center
          • ceo-2016
    • returns Tournament
  • parse(data)
    • parse smash.gg api data into a Tournament object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns Tournament
  • get_events()
    • get all the events for a given tournament
    • returns Event[]
  • get_phases()
    • get all the phases for a given tournament
    • returns Phase[]
  • get_phase_groups()
    • get all the phase groups for a given tournament
    • returns PhaseGroup[]
  • get_attendees()
    • get all the attendees for a given tournament
    • returns Attendee[]
  • get_entrants()
    • get all the entrants for a given tournament
    • returns Entrant[]
  • get_sets()
    • get all of the sets played for a given tournament
    • returns GGSet[]
  • get_incomplete_sets()
    • get all of the incomplete sets for a given tournament
    • returns GGSet[]
  • get_completed_sets()
    • get all of the completed sets for a given tournament
    • returns GGSet[]
Instance
  • get_id()
    • get the id property of the tournament
    • returns int
  • get_name()
    • get the name property of the tournament
    • returns string
  • get_slug()
    • get the slug property of the tournament
    • returns string
  • get_start_time()
    • get the start_time property of the tournament
    • returns int
  • get_end_time()
    • get the end_time property of the tournament
    • returns int
  • get_timezone()
    • get the timezone property of the tournament
    • returns string
  • get_venue()
    • get the venue property of the tournament
    • returns Venue
  • get_organizer()
    • get the organizer property of the tournament
    • returns Organizer

Event

Properties

  • id
    • int
    • the numeric id of the event
  • name
    • string
    • the name of the event
  • slug
    • string
    • the url slug of the event
  • state
    • string
    • the progress of the event
    • possible values:
      • CREATED
      • ACTIVE
      • COMPLETED
      • READY
      • INVALID
      • CALLED
      • QUEUED
  • start_at
    • int
    • unix epoch of the start time of the event
  • num_entrants
    • int
    • number of entrants in the event
  • check_in_buffer
    • int
    • seconds of how long before the event start will the check-in end
  • check_in_duration
    • int
    • seconds of how long the check-in will last
  • check_in_enabled
    • bool
    • t/f of whether this event uses check-in
  • is_online
    • bool
    • t/f of whether this event is online
  • team_name_allowed
    • bool
    • t/f of whether this event allows team names
  • team_management_deadline
    • int
    • unix epoch of when team management is no longer allowed

Methods

Statics
  • get(tournament_slug, event_slug)
    • get an Event object for the corresponding tournament and event slugs
    • parameters
      • tournament_slug
        • string
        • long-name slug for a tournament
          • function-3-recursion-series
          • tipped-off-12-presented-by-the-lab-gaming-center
          • ceo-2016
      • event_slug
        • string
        • slug of the target event
          • melee-singles
          • dragon-ball-fighterz
          • smash-bros-ultimate
    • returns Event
  • parse(data)
    • parse smash.gg api data into an Event object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns Event
  • get_phase()
    • get the phases of the event
    • returns Phase[]
  • get_phase_groups()
    • get the phase groups of the event
    • returns PhaseGroup[]
  • get_sets()
    • get all of the sets played for a given event
    • returns GGSet[]
  • get_incomplete_sets()
    • get all of the incomplete sets for a given event
    • returns GGSet[]
  • get_completed_sets()
    • get all of the completed sets for a given event
    • returns GGSet[]
Instance
  • get_id()
    • get the id property of the event
    • returns int
  • get_name()
    • get the name property of the event
    • returns string
  • get_slug()
    • get the slug property of the event
    • returns string
  • get_state()
    • get the state property of the event
    • returns string
  • get_start_at()
    • get the start_at property of the event
    • returns int
  • get_num_entrants()
    • get the num_entrants property of the event
    • returns int
  • get_check_in_buffer()
    • get the check_in_buffer property of the event
    • returns int
  • get_check_in_duration()
    • get the check_in_duration property of the event
    • returns int
  • get_check_in_enabled()
    • get the check_in_enabled property of the event
    • returns bool
  • get_is_online()
    • get the is_online property of the event
    • returns bool
  • get_team_name_allowed()
    • get the team_name_allowed property of the event
    • returns bool
  • get_team_management_deadline()
    • get the team_management_deadline property of the event
    • returns int

Phase

Properties

  • id
    • int
    • numeric id of the phase
  • name
    • string
    • name of the phase
  • num_seeds
    • int
    • number of seeds that are in the phase
  • group_count
    • int
    • number of phase groups that are in the phase

Methods

Statics
  • get(phase_id)
    • get data from smash.gg api and get a Phase object from it
    • parameters
      • phase_id
        • int
        • numeric id of the phase
    • returns Phase
  • parse(data)
    • parse smash.gg api data into an Phase object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns Phase
  • get_phase_groups()
    • get the phase groups for the given phase
    • returns PhaseGroup[]
  • get_sets()
    • get all of the sets played for the given phase
    • returns GGSet[]
  • get_incomplete_sets()
    • get all of the incomplete sets for the given phase
    • returns GGSet[]
  • get_completed_sets()
    • get all of the completed sets for the given phase
    • returns GGSet[]
Instance
  • get_id()
    • get the id property of the Phase
    • returns int
  • get_name()
    • get the name property of the Phase
    • returns string
  • get_num_seeds()
    • get the num_seeds property of the Phase
    • returns int
  • get_group_count()
    • get the group_count property of the Phase
    • returns int

PhaseGroup

Properties

  • id
    • int
    • numeric id of the phase group
  • display_identifier
    • string
    • the name of the phase group
  • first_round_time
    • int
    • unix epoch of the time the first round of this phase group begins
  • state
    • int
    • progress of the phase group
  • phase_id
    • int
    • numeric id of the phase this phase group belongs to
  • wave_id
    • int
    • numeric id of the wave this phase group belongs to
  • tiebreak_order
    • json
    • the tiebreak order for this phase group

Methods

Statics
  • get(phase_group_id)
    • get data from smash.gg and get a PhaseGroup object from it
    • parameters
      • phase_group_id
        • int
        • numeric id of the phase group
  • parse(data)
    • parse smash.gg api data into a PhaseGroup object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns PhaseGroup
  • get_sets()
    • get all of the sets played for the given phase group
    • returns GGSet[]
  • get_incomplete_sets()
    • get all of the incomplete sets for the given phase group
    • returns GGSet[]
  • get_completed_sets()
    • get all of the completed sets for the given phase group
    • returns GGSet[]
Instance
  • get_id()
    • get the id property of the phase group
    • returns int
  • get_display_identifier()
    • get the display_identifier property of the phase group
    • returns string
  • get_first_round_time()
    • get the first_round_time property of the phase group
    • returns int
  • get_state()
    • get the state property of the phase group
    • returns int
  • get_phase_id()
    • get the phase_id property of the phase group
    • returns int
  • get_wave_id()
    • get the wave_id property of the phase group
    • returns int
  • get_tiebreak_order()
    • get the tiebreak_order property of the phase group
    • returns json

GGSet

Properties

  • id
    • int
    • numeric id of the set
  • event_id
    • int
    • numeric id of the event this set belongs to
  • phase_group_id
    • int
    • numeric id of the phase group this set belongs to
  • display_score
    • string
    • display string for this set.
      • Format: Smashtag1 Score1 - Score2 Smashtag2
  • full_round_text
    • string
    • full name of the round this set takes place in
  • round
    • int
    • numeric identifier for the round this set takes place in
  • started_at
    • int
    • unix epoch of the time this set started at
  • completed_at
    • int
    • unix epoch of the time this set ended at
  • winner_id
    • int
    • id number of the of Entrant who won the set
  • total_games
    • int
    • total number of games played in this set
  • state
    • int
    • progress of the set
  • player1
    • Player
    • 1st player in the set
  • player2
    • Player
    • 2nd player in the set
  • score1
    • int
    • score of player 1 in the set
  • score2
    • int
    • score of player 2 in the set

Methods

Statics
  • parse(data)
    • parse smash.gg api data into a GGSet object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns GGSet
  • parse_display_score(display_score)
    • parse a GGSet's display score property
    • parameters
      • data
        • string
        • display score string from a GGSet object
    • returns custom object:
      • p1_tag
        • string or None
        • smashtag of player 1
      • p1_score
        • int
        • score of player 1
      • p2_tag
        • string or None
        • smashtag of player 2
      • p2_score
        • int
        • score of player 2
Instance
  • get_id()
    • get the id property of the event
    • returns int
  • get_event_id()
    • get the event_id property of the event
    • returns int
  • get_phase_group_id()
    • get the phase_group_id property of the event
    • returns int
  • get_display_score()
    • get the display_score property of the event
    • returns string
  • get_full_round_text()
    • get the full_round_text property of the event
    • returns string
  • get_round()
    • get the round property of the event
    • returns int
  • get_started_at()
    • get the started_at property of the event
    • returns int
  • get_completed_at()
    • get the completed_at property of the event
    • returns int
  • get_winner_id()
    • get the winner_id property of the event
    • returns int
  • get_total_games()
    • get the total_games property of the event
    • returns int
  • get_state()
    • get the state property of the event
    • returns int
  • get_player1()
    • get the player1 property of the event
    • returns Player
  • get_player2()
    • get the player2 property of the event
    • returns Player
  • get_score1()
    • get the score1 property of the event
    • returns int
  • get_score2()
    • get the score2 property of the event
    • returns int

Player

Properties

  • tag
    • string
    • smashtag/identifier for this Player
  • entrant_id
    • int
    • unique entrant id number for this Player
  • attendee_ids
    • int[]
    • array of attendee ids for the attendees who make up this Player

Methods

Statics
  • parse(tag, data)
    • parse smash.gg api data into a Player object
    • parameters
      • tag
        • string
        • smashtag of the player
      • data
        • json
        • data from smashgg to be parsed into entrant and attendee ids
    • returns Player
Instance
  • get_tag()
    • get the tag property of this player
    • returns string
  • get_entrant_id()
    • get the entrant_id property of this player
    • returns int
  • get_attendee_ids()
    • get the attendee_ids property of this player
    • returns int[]

Entrant

Properties

  • id
    • int
    • id number of the entrant
  • name
    • string
    • name of the entrant
  • event_id
    • int
    • id number of the event this entrant belongs to
  • skill
    • int
    • skill number of the entrant
  • attendee_data
    • Attendee[]
    • array of attendee data attached to this entrant

Methods

Statics
  • parse(data)
    • parse smash.gg api data into an Entrant object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns Entrant
Instance
  • get_id()
    • get the id property of the Entrant
    • returns
  • get_name()
    • get the name property of the Entrant
    • returns
  • get_event_id()
    • get the event_id property of the Entrant
    • returns
  • get_skill()
    • get the skill property of the Entrant
    • returns
  • get_attendee_data()
    • get the attendee_data property of the Entrant
    • returns

Attendee

Properties

  • id
    • int
    • numeric id of the attendee
  • gamer_tag
    • string
    • smashtag of the attendee
  • prefix
    • string
    • sponsor tag of the attendee (like PG or RCS)
  • created_at
    • int
    • unix epoch of the time this attendee object was created
  • claimed
    • bool
    • t/f for if the attendee is claimed or not
  • verified
    • bool
    • t/f for if the attendee is verified as actually being in the tournament
  • player_id
    • int
    • id number of the corresponding User object
  • phone_number
    • string
    • phone number of the attendee
  • connected_accounts
    • json
    • object showing all accounts connected to this attendee
  • contact_info
    • json
    • contact info of the attendee
  • event_ids
    • int[]
    • id number of all the events this attendee entered

Methods

Statics
  • parse(data)
    • parse smash.gg api data into a Attendee object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns Attendee
Instance
  • get_id()
    • get the id property of the Attendee
    • returns
  • get_gamer_tag()
    • get the gamer_tag property of the Attendee
    • returns
  • get_prefix()
    • get the prefix property of the Attendee
    • returns
  • get_created_at()
    • get the created_at property of the Attendee
    • returns
  • get_claimed()
    • get the claimed property of the Attendee
    • returns
  • get_verified()
    • get the verified property of the Attendee
    • returns
  • get_player_id()
    • get the player_id property of the Attendee
    • returns
  • get_phone_number()
    • get the phone_number property of the Attendee
    • returns
  • get_connected_accounts()
    • get the connected_accounts property of the Attendee
    • returns
  • get_contact_info()
    • get the contact_info property of the Attendee
    • returns
  • get_event_ids()
    • get the event_ids property of the Attendee
    • returns

Stream

Properties

  • id
    • int
    • numeric id of the stream
  • event_id
    • int
    • numeric id of the event this stream is a part of
  • tournament_id
    • int
    • numeric id of the tournament this stream is a part of
  • stream_name
    • string
    • name of the stream
  • num_setups
    • int
    • number of setups on the stream
  • stream_source
    • string
    • web source of the stream, like Twitch
  • stream_type
    • string
    • the type of the current stream
  • stream_type_id
    • int
    • the numeric type of the current stream
  • is_online
    • bool
    • t/f for if the current stream is online
  • enabled
    • bool
    • t/f for if the current stream is enabled
  • follower_count
    • int
    • the number of followers the stream has
  • removes_tasks
    • bool
    • t/f for if the current stream removes tasks
  • stream_status
    • string
    • the status of the current stream
  • stream_game
    • string
    • the game the current stream is live streaming
  • stream_logo
    • string
    • the url to the logo image of the stream

Methods

Statics
  • get(id)
    • get raw stream data from smashgg for the given id
    • parameters
      • id
        • int
        • identification number of the stream
    • returns Stream
  • parse(data)
    • parse smash.gg api data into an Stream object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns Stream
Instance
  • get_id()
    • get the id property of the stream
    • returns
  • get_event_id()
    • get the event_id property of the stream
    • returns
  • get_tournament_id()
    • get the tournament_id property of the stream
    • returns
  • get_stream_name()
    • get the stream_name property of the stream
    • returns
  • get_num_setups()
    • get the num_setups property of the stream
    • returns
  • get_stream_source()
    • get the stream_source property of the stream
    • returns
  • get_stream_type()
    • get the stream_type property of the stream
    • returns
  • get_stream_type_id()
    • get the stream_type_id property of the stream
    • returns
  • get_is_online()
    • get the is_online property of the stream
    • returns
  • get_enabled()
    • get the enabled property of the stream
    • returns
  • get_follower_count()
    • get the follower_count property of the stream
    • returns
  • get_removes_tasks()
    • get the removes_tasks property of the stream
    • returns
  • get_stream_status()
    • get the stream_status property of the stream
    • returns
  • get_stream_game()
    • get the stream_game property of the stream
    • returns
  • get_stream_logo()
    • get the stream_logo property of the stream
    • returns

StreamQueue

Properties

  • id
    • id of the Tournament this stream queue belongs to
  • stream
    • Stream
    • stream this queue is associated with
  • sets
    • GGSet[]
    • sets in the queue

Methods

  • get(tournament_id)

    • get the raw stream queue data for a given tournament id
    • parameters
      • tournament_id
        • int
        • identification number of the tournament
    • returns StreamQueue

  • parse(data)

    • parse smash.gg api data into an StreamQueue object
    • parameters
      • data
        • json
        • http response data from a smash.gg api call
    • returns StreamQueue
Instance
  • get_stream()
    • get the StreamQueue's stream property
    • Stream
  • get_sets()
    • get the StreamQueue's sets property
    • GGSet[]

How to run

NOTE: In order to use properly, you will need to create an .env file with the API_TOKEN inside of it, it should look like this: API_TOKEN=<insert smash.gg API token here> If you already have Docker installed, you may run the scripts in the /docker directory. You need to build the container before running it, so run build before run. If you would like to do both consecutively, you may run the buildAndRun script.