tangled_game_client 3.1.1

Simple Game Service API

tangled-game-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 3.1.1
• Package version: 3.1.1
• Generator version: 7.9.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import tangled_game_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import tangled_game_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import tangled_game_client
from tangled_game_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = tangled_game_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with tangled_game_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tangled_game_client.DefaultApi(api_client)
    create_game_request = tangled_game_client.CreateGameRequest() # CreateGameRequest | 

    try:
        # Create a new game
        api_response = api_instance.create_game(create_game_request)
        print("The response of DefaultApi->create_game:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->create_game: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	create_game	POST /create_game	Create a new game
DefaultApi	get_game_state	GET /game_state	Get the state of the game
DefaultApi	get_legal_moves	GET /legal_moves	Get the legal moves for the current game state
DefaultApi	get_score	GET /get_score	Get the score of the game
DefaultApi	get_scorers	GET /get_scorers	Get the list of available scoring algorithms
DefaultApi	join_game	POST /join_game	Connect client to a game and get player token
DefaultApi	make_move	POST /move	Make a move in the game
DefaultApi	public_create_game	POST /public/create_game	Create a new game (public)
DefaultApi	public_get_game_state	GET /public/game_state	Get the state of the game (public)
DefaultApi	public_get_legal_moves	GET /public/legal_moves	Get the legal moves for the current game state (public)
DefaultApi	public_get_score	GET /public/get_score	Get the score of the game (public)
DefaultApi	public_get_scorers	GET /public/get_scorers	Get the list of available scoring algorithms (public)
DefaultApi	public_join_game	POST /public/join_game	Connect client to a game and get player token (public)
DefaultApi	public_make_move	POST /public/move	Make a move in the game (public)
DefaultApi	public_secret_create_game	POST /secret_create_game

Documentation For Models

• CreateGameRequest
• CreateGameResponse
• ErrorResponse
• GetGameState200Response
• GetGameState200ResponseState
• GetLegalMoves200Response
• GetScore200Response
• GetScore200ResponseScore
• GetScorers200Response
• JoinGame200Response
• JoinGameRequest
• MakeMove200Response
• MakeMove403Response
• MakeMoveRequest
• SecretCreateGameRequest
• SecretCreateGameResponse

Documentation For Authorization

Authentication schemes defined for the API:

auth0

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://snowdropquantum.ca.auth0.com/authorize
• Scopes:
• read: Grants read access
• write: Grants write access
• delete: Grants delete access

Author