Hightech A-maze-ing API
Project description
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
pip install hightech_amazeing
(you may need to run pip
with root permission: sudo pip install amazeing-client
)
Then import the package:
import hightech_amazeing
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 hightech_amazeing
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import hightech_amazeing
from hightech_amazeing.rest import ApiException
from pprint import pprint
# Configure API key authorization: User token
configuration = hightech_amazeing.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = hightech_amazeing.PlayerApi(hightech_amazeing.ApiClient(configuration))
try:
# Forget your current progress.
api_response = api_instance.forget()
pprint(api_response)
except ApiException as e:
print("Exception when calling MazeApi->collect_score: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
MazeApi | collect_score | ** | |
POST** /api/maze/collectScore | 💰 Collect score from your hand to your bag. | ||
MazeApi | exit_maze | POST /api/maze/exit | 🚪 Exit the maze. |
MazeApi | move | POST /api/maze/move | Move in the supplied direction. |
MazeApi | possible_actions | ** | |
GET** /api/maze/possibleActions | 👀 Get the list of possible actions, from the tile where you are standing. | ||
MazeApi | tag | ** | |
POST** /api/maze/tag | Tag the current tile with the given (non-negative) number | ||
MazesApi | all | GET /api/mazes/all | 📜 All the mazes that exist in the game. |
MazesApi | enter | POST /api/mazes/enter | 🌟 Enter a maze. |
PlayerApi | forget | DELETE /api/player/forget | 🙈 Forget your current progress. |
PlayerApi | get | GET /api/player | 👤 Obtain information about yourself. |
PlayerApi | register | POST /api/player/register | 📝 Register yourself here. |
Documentation For Models
Documentation For Authorization
User token
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
HighTechICT
amazeing-client
This document describes the API of the A-maze-ing evening server. This API consists of three different endpoints, which are detailed below. - To register yourself as a player use the Player endpoint. - To get information about the available mazes and enter a specific maze use the Mazes endpoint. - To navigate a maze use the Maze endpoint.
This Python package is automatically generated by the Swagger Codegen project:
- API version: v2
- Package version: 1.0.1
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for hightech_amazeing-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5a829b48f6f27a6a4ca34b224987a5b0a698b61e50ef33c5130fa493b858990 |
|
MD5 | 62154fc51a51cd29530dc1996ced423c |
|
BLAKE2b-256 | ef5b6c905eb81a6cebe82994ce387760ab8808a463e64225df20f66fbf2b4fca |