board-mate/rpi/api-resources/board_mate_client

openapi-client

boardmate_api API

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

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.5.0
• 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 board_mate_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 board_mate_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import board_mate_client
from board_mate_client.rest import ApiException
from pprint import pprint

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

# Enter a context with an instance of the API client
with board_mate_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = board_mate_client.DefaultApi(api_client)
    game_id = 'game_id_example'  # str | 
    move_dto = board_mate_client.MoveDto()  # MoveDto | 

    try:
        # POST moves/add/{gameId}
        api_response = api_instance.add_move(game_id, move_dto)
        print("The response of DefaultApi->add_move:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->add_move: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://boardmate_api

Class	Method	HTTP request	Description
DefaultApi	add_move	POST /moves/add/{gameId}	POST moves/add/{gameId}
DefaultApi	create_party	POST /create	POST create
DefaultApi	retrieve_games	GET /games/{id}	GET games/{id}

Documentation For Models

• GameDto
• MoveDto
• ResponseBodyGameDto
• ResponseBodyString

Documentation For Authorization

Endpoints do not require authorization.

Author