BlueMapWrapper

Back to README.md

Clients

• Client
• AsyncClient

Client

class BlueMapWrapper.Client

Synchronous Client for requesting, uses the requests library.

Slower than AsyncClient, more suitable for short and simple projects

Parameters

• base_url

Methods

• fetch_maps
• fetch_marker_collection
• fetch_player_collection
• fetch_collection

Parameters

base_url (str)

The base url of the Blue Map

Methods

fetch_maps()

Get a list of available maps from the API.

Returns:

A list of strings of available maps

Return Type:

List[Union[Text, None]]

fetch_marker_collection()

Get a list of available maps from the API.

Parameters:

• world (str): The name of the world to fetch from

  Returns:

  MarkerCollection Object with all available marker collections

  Return Type:

  MarkerCollection

fetch_player_collection()

Get a list of all visible players from the API.

Parameters:

• world (str): The name of the world to fetch from

  Returns:

  PlayerCollection Object with all available players

  Return Type:

  PlayerCollection

fetch_collection()

Get a lists of MarkerSets and visible players form the API. Offers faster performance due to threaded requesting

Parameters:

• world (str): The name of the world to fetch from

  Returns:

  Collection Object with a MarkerCollection and PlayerCollection Object

  Return Type:

  Collection

AsyncClient

class BlueMapWrapper.AsyncClient

Asynchronous Client for requesting, uses the aiohttp library.

Faster than Client, suitable for larger and more complex projects

Parameters

• base_url

Methods

• await fetch_maps
• await fetch_marker_collection
• await fetch_player_collection
• await fetch_collection

Parameters

base_url (str)

The base url of the Blue Map

Methods

await fetch_maps()

Get a list of available maps from the API.

Returns:

A list of strings of available maps

Return Type:

List[Union[Text, None]]

await fetch_marker_collection()

Get a list of available maps from the API.

Parameters:

• world (str): The name of the world to fetch from

  Returns:

  MarkerCollection Object with all available marker collections

  Return Type:

  MarkerCollection

await fetch_players_collection()

Get a list of all visible players from the API.

Parameters:

• world (str): The name of the world to fetch from

  Returns:

  PlayerCollection Object with all available players

  Return Type:

  PlayerCollection

await fetch_collection()

Get a lists of MarkerSets and visible players form the API. Offers faster performance due to threaded requesting

Parameters:

• world (str): The name of the world to fetch from

  Returns:

  Collection Object with a MarkerCollection and PlayerCollection Object

  Return Type:

  Collection

This site is open source. Improve this page.