# 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](https://openapi-generator.tech) project:
- API version: 4.0.0
- Package version: 4.0.0
- Generator version: 7.10.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:
```sh
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:
```python
import tangled_game_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import tangled_game_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/DefaultApi.md#create_game) | **POST** /create_game | Create a new game
*DefaultApi* | [**get_bots**](docs/DefaultApi.md#get_bots) | **GET** /bots | Get the list of available bots
*DefaultApi* | [**get_game_state**](docs/DefaultApi.md#get_game_state) | **GET** /game_state | Get the state of the game
*DefaultApi* | [**get_legal_moves**](docs/DefaultApi.md#get_legal_moves) | **GET** /legal_moves | Get the legal moves for the current game state
*DefaultApi* | [**get_score**](docs/DefaultApi.md#get_score) | **GET** /adjudicate | Adjudicate the score of the game
*DefaultApi* | [**get_scorers**](docs/DefaultApi.md#get_scorers) | **GET** /get_adjudicators | Get the list of available adjudicator algorithms
*DefaultApi* | [**join_game**](docs/DefaultApi.md#join_game) | **POST** /join_game | Connect client to a game and get player token
*DefaultApi* | [**make_move**](docs/DefaultApi.md#make_move) | **POST** /move | Make a move in the game
*DefaultApi* | [**public_create_game**](docs/DefaultApi.md#public_create_game) | **POST** /public/create_game | Create a new game (public)
*DefaultApi* | [**public_get_game_state**](docs/DefaultApi.md#public_get_game_state) | **GET** /public/game_state | Get the state of the game (public)
*DefaultApi* | [**public_get_legal_moves**](docs/DefaultApi.md#public_get_legal_moves) | **GET** /public/legal_moves | Get the legal moves for the current game state (public)
*DefaultApi* | [**public_get_score**](docs/DefaultApi.md#public_get_score) | **GET** /public/adjudicate | Adjudicate the score of the game (public)
*DefaultApi* | [**public_get_scorers**](docs/DefaultApi.md#public_get_scorers) | **GET** /public/get_adjudicators | Get the list of available adjudicator algorithms (public)
*DefaultApi* | [**public_join_game**](docs/DefaultApi.md#public_join_game) | **POST** /public/join_game | Connect client to a game and get player token (public)
*DefaultApi* | [**public_make_move**](docs/DefaultApi.md#public_make_move) | **POST** /public/move | Make a move in the game (public)
*DefaultApi* | [**public_secret_create_game**](docs/DefaultApi.md#public_secret_create_game) | **POST** /secret_create_game |
## Documentation For Models
- [CreateGameRequest](docs/CreateGameRequest.md)
- [CreateGameResponse](docs/CreateGameResponse.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [GetGameState200Response](docs/GetGameState200Response.md)
- [GetGameState200ResponseState](docs/GetGameState200ResponseState.md)
- [GetLegalMoves200Response](docs/GetLegalMoves200Response.md)
- [GetScore200Response](docs/GetScore200Response.md)
- [GetScore200ResponseScore](docs/GetScore200ResponseScore.md)
- [GetScorers200Response](docs/GetScorers200Response.md)
- [JoinGame200Response](docs/JoinGame200Response.md)
- [JoinGameRequest](docs/JoinGameRequest.md)
- [MakeMove200Response](docs/MakeMove200Response.md)
- [MakeMove403Response](docs/MakeMove403Response.md)
- [MakeMoveRequest](docs/MakeMoveRequest.md)
- [SecretCreateGameRequest](docs/SecretCreateGameRequest.md)
- [SecretCreateGameResponse](docs/SecretCreateGameResponse.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="auth0"></a>
### 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
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "tangled_game_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Simple Game Service API",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/b6/d6/60e048876ded8c2f377b40c81ae30b241d51d5f7de0dee7532922e5569f2/tangled_game_client-4.0.0.tar.gz",
"platform": null,
"description": "# tangled-game-client\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 4.0.0\n- Package version: 4.0.0\n- Generator version: 7.10.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport tangled_game_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport tangled_game_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport tangled_game_client\nfrom tangled_game_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = tangled_game_client.Configuration(\n host = \"http://localhost\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n\n# Enter a context with an instance of the API client\nwith tangled_game_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = tangled_game_client.DefaultApi(api_client)\n create_game_request = tangled_game_client.CreateGameRequest() # CreateGameRequest | \n\n try:\n # Create a new game\n api_response = api_instance.create_game(create_game_request)\n print(\"The response of DefaultApi->create_game:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->create_game: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**create_game**](docs/DefaultApi.md#create_game) | **POST** /create_game | Create a new game\n*DefaultApi* | [**get_bots**](docs/DefaultApi.md#get_bots) | **GET** /bots | Get the list of available bots\n*DefaultApi* | [**get_game_state**](docs/DefaultApi.md#get_game_state) | **GET** /game_state | Get the state of the game\n*DefaultApi* | [**get_legal_moves**](docs/DefaultApi.md#get_legal_moves) | **GET** /legal_moves | Get the legal moves for the current game state\n*DefaultApi* | [**get_score**](docs/DefaultApi.md#get_score) | **GET** /adjudicate | Adjudicate the score of the game\n*DefaultApi* | [**get_scorers**](docs/DefaultApi.md#get_scorers) | **GET** /get_adjudicators | Get the list of available adjudicator algorithms\n*DefaultApi* | [**join_game**](docs/DefaultApi.md#join_game) | **POST** /join_game | Connect client to a game and get player token\n*DefaultApi* | [**make_move**](docs/DefaultApi.md#make_move) | **POST** /move | Make a move in the game\n*DefaultApi* | [**public_create_game**](docs/DefaultApi.md#public_create_game) | **POST** /public/create_game | Create a new game (public)\n*DefaultApi* | [**public_get_game_state**](docs/DefaultApi.md#public_get_game_state) | **GET** /public/game_state | Get the state of the game (public)\n*DefaultApi* | [**public_get_legal_moves**](docs/DefaultApi.md#public_get_legal_moves) | **GET** /public/legal_moves | Get the legal moves for the current game state (public)\n*DefaultApi* | [**public_get_score**](docs/DefaultApi.md#public_get_score) | **GET** /public/adjudicate | Adjudicate the score of the game (public)\n*DefaultApi* | [**public_get_scorers**](docs/DefaultApi.md#public_get_scorers) | **GET** /public/get_adjudicators | Get the list of available adjudicator algorithms (public)\n*DefaultApi* | [**public_join_game**](docs/DefaultApi.md#public_join_game) | **POST** /public/join_game | Connect client to a game and get player token (public)\n*DefaultApi* | [**public_make_move**](docs/DefaultApi.md#public_make_move) | **POST** /public/move | Make a move in the game (public)\n*DefaultApi* | [**public_secret_create_game**](docs/DefaultApi.md#public_secret_create_game) | **POST** /secret_create_game | \n\n\n## Documentation For Models\n\n - [CreateGameRequest](docs/CreateGameRequest.md)\n - [CreateGameResponse](docs/CreateGameResponse.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [GetGameState200Response](docs/GetGameState200Response.md)\n - [GetGameState200ResponseState](docs/GetGameState200ResponseState.md)\n - [GetLegalMoves200Response](docs/GetLegalMoves200Response.md)\n - [GetScore200Response](docs/GetScore200Response.md)\n - [GetScore200ResponseScore](docs/GetScore200ResponseScore.md)\n - [GetScorers200Response](docs/GetScorers200Response.md)\n - [JoinGame200Response](docs/JoinGame200Response.md)\n - [JoinGameRequest](docs/JoinGameRequest.md)\n - [MakeMove200Response](docs/MakeMove200Response.md)\n - [MakeMove403Response](docs/MakeMove403Response.md)\n - [MakeMoveRequest](docs/MakeMoveRequest.md)\n - [SecretCreateGameRequest](docs/SecretCreateGameRequest.md)\n - [SecretCreateGameResponse](docs/SecretCreateGameResponse.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"auth0\"></a>\n### auth0\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: https://snowdropquantum.ca.auth0.com/authorize\n- **Scopes**: \n - **read**: Grants read access\n - **write**: Grants write access\n - **delete**: Grants delete access\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Simple Game Service API",
"version": "4.0.0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" simple game service api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36c10dc1e4ae084b92e60f3fd547de13d167466c164f40c92b6ec86bd57afb64",
"md5": "15b207a60577d5c425732e26c8ef24ec",
"sha256": "0ef0c3c529a680a355fe52b481e7166f0b61d0f8baaabbf08a0c1fbae571be5c"
},
"downloads": -1,
"filename": "tangled_game_client-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15b207a60577d5c425732e26c8ef24ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 48263,
"upload_time": "2024-11-26T01:50:57",
"upload_time_iso_8601": "2024-11-26T01:50:57.939699Z",
"url": "https://files.pythonhosted.org/packages/36/c1/0dc1e4ae084b92e60f3fd547de13d167466c164f40c92b6ec86bd57afb64/tangled_game_client-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6d660e048876ded8c2f377b40c81ae30b241d51d5f7de0dee7532922e5569f2",
"md5": "6b08ac7c49b2297120494b27d7d66366",
"sha256": "aaa1c42a5d2a7b900695e589e6486a3e645057ed40006db40dbdf4f013cebbab"
},
"downloads": -1,
"filename": "tangled_game_client-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6b08ac7c49b2297120494b27d7d66366",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 27918,
"upload_time": "2024-11-26T01:50:59",
"upload_time_iso_8601": "2024-11-26T01:50:59.041931Z",
"url": "https://files.pythonhosted.org/packages/b6/d6/60e048876ded8c2f377b40c81ae30b241d51d5f7de0dee7532922e5569f2/tangled_game_client-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 01:50:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "tangled_game_client"
}
JSON
