<h1><img alt="bluemap logo" src="Documentation/images/bluemap_logo.png" height=25px> BlueMapWrapper</h1>
<a href="https://discord.gg/sBMqepFV6m"><img src="https://discord.com/api/guilds/1386414999932506197/embed.png" alt="Discord Link" height="20"></a>
<a href='https://ko-fi.com/O5O1180EK8' target='_blank'><img height='36' style='border:0px;height:20px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
An open-sourced API wrapper for BlueMap for Python!!
This wrapper is used for getting information from existing Blue Maps, NOT to create one.
# Installation
>## Windows
> pip install bluemap_wrapper
> ## Linux
> python -m pip install bluemap_wrapper
## Quick Example
```python
import asyncio
from BlueMapWrapper import AsyncClient, KEYS
async def main():
# printing out all players and lands plugin markers
# Setting up Async Client, AsyncClient Object
client = AsyncClient(base_url='http://map.eldrath.com:20098')
# Fetching player and marker Collection from map, Collection Object
collection = await client.fetch_collection('world')
for player in collection.player_collection: # Iterate through all players
print(f"Player: {player.name}\nPosition: {player.position}")
# Getting MarkerCollection Object from Collection
marker_collection = collection.marker_collection
# Getting Marker for Lands Plugin
lands = marker_collection.from_key(KEYS.LANDS)
for marker in lands: # Iterate though markers in lands
print(f"Name: {marker.label}\nPosition: {marker.position}")
await client.close() # Close client after use
if __name__ == '__main__':
asyncio.run(main())
```
# Documentation Contents
- ## [Clients](Documentation/Clients.md#clients)
- [Client](Documentation/Clients.md#client)
- [AsyncClient](Documentation/Clients.md#asyncclient)
- ## [Collections](Documentation/Collections.md#collections)
- [Collection](Documentation/Collections.md#collection)
- [MarkerCollection](Documentation/Collections.md#markercollection)
- [PlayerCollection](Documentation/Collections.md#playercollection)
- ## [Markers](Documentation/Marker#markers)
- [ExtrudeMarker](Documentation/Marker.md#extrudemarkerbasemarker)
- [HTMLMarker](Documentation/Marker.md#htmlmarkerbasemarker)
- [LineMarker](Documentation/Marker.md#linemarkerbasemarker)
- [POIMarker](Documentation/Marker.md#poimarkerbasemarker)
- [ShapeMarker](Documentation/Marker.md#shapemarkerbasemarker)
- ## [MarkerSets](Documentation/MarkerSet.md)
- [MarkerSet](Documentation/MarkerSet.md#markerset)
- ## [Players](Documentation/Player.md#players)
- [Player](Documentation/Player.md#player)
- ## [Positioning](Documentation/Positioning.md)
- [Position](Documentation/Positioning.md#position)
- [Rotation](Documentation/Positioning.md#rotation)
Raw data
{
"_id": null,
"home_page": null,
"name": "BlueMapWrapper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "BlueMap, BlueMapWrapper, BlueMapWrapper.py",
"author": null,
"author_email": "RyanStudio <ryanstudiobusiness@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b0/5b/0c1975e90f1e4e1987528e30a202af6772e166f7787909d808bbcc769966/bluemapwrapper-1.0.4.tar.gz",
"platform": null,
"description": "<h1><img alt=\"bluemap logo\" src=\"Documentation/images/bluemap_logo.png\" height=25px> BlueMapWrapper</h1>\r\n<a href=\"https://discord.gg/sBMqepFV6m\"><img src=\"https://discord.com/api/guilds/1386414999932506197/embed.png\" alt=\"Discord Link\" height=\"20\"></a>\r\n<a href='https://ko-fi.com/O5O1180EK8' target='_blank'><img height='36' style='border:0px;height:20px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>\r\n\r\nAn open-sourced API wrapper for BlueMap for Python!!\r\n\r\nThis wrapper is used for getting information from existing Blue Maps, NOT to create one.\r\n\r\n# Installation\r\n>## Windows\r\n> pip install bluemap_wrapper\r\n> ## Linux\r\n> python -m pip install bluemap_wrapper\r\n\r\n## Quick Example\r\n\r\n```python\r\nimport asyncio\r\nfrom BlueMapWrapper import AsyncClient, KEYS\r\n\r\n\r\nasync def main():\r\n # printing out all players and lands plugin markers\r\n\r\n # Setting up Async Client, AsyncClient Object\r\n client = AsyncClient(base_url='http://map.eldrath.com:20098')\r\n\r\n # Fetching player and marker Collection from map, Collection Object\r\n collection = await client.fetch_collection('world')\r\n\r\n for player in collection.player_collection: # Iterate through all players\r\n print(f\"Player: {player.name}\\nPosition: {player.position}\")\r\n\r\n # Getting MarkerCollection Object from Collection\r\n marker_collection = collection.marker_collection\r\n\r\n # Getting Marker for Lands Plugin \r\n lands = marker_collection.from_key(KEYS.LANDS)\r\n\r\n for marker in lands: # Iterate though markers in lands\r\n print(f\"Name: {marker.label}\\nPosition: {marker.position}\")\r\n\r\n await client.close() # Close client after use\r\n\r\n\r\nif __name__ == '__main__':\r\n asyncio.run(main())\r\n```\r\n\r\n# Documentation Contents\r\n- ## [Clients](Documentation/Clients.md#clients)\r\n - [Client](Documentation/Clients.md#client)\r\n - [AsyncClient](Documentation/Clients.md#asyncclient)\r\n- ## [Collections](Documentation/Collections.md#collections)\r\n - [Collection](Documentation/Collections.md#collection)\r\n - [MarkerCollection](Documentation/Collections.md#markercollection)\r\n - [PlayerCollection](Documentation/Collections.md#playercollection)\r\n- ## [Markers](Documentation/Marker#markers)\r\n - [ExtrudeMarker](Documentation/Marker.md#extrudemarkerbasemarker)\r\n - [HTMLMarker](Documentation/Marker.md#htmlmarkerbasemarker)\r\n - [LineMarker](Documentation/Marker.md#linemarkerbasemarker)\r\n - [POIMarker](Documentation/Marker.md#poimarkerbasemarker)\r\n - [ShapeMarker](Documentation/Marker.md#shapemarkerbasemarker)\r\n- ## [MarkerSets](Documentation/MarkerSet.md)\r\n - [MarkerSet](Documentation/MarkerSet.md#markerset)\r\n- ## [Players](Documentation/Player.md#players)\r\n - [Player](Documentation/Player.md#player)\r\n- ## [Positioning](Documentation/Positioning.md)\r\n - [Position](Documentation/Positioning.md#position)\r\n - [Rotation](Documentation/Positioning.md#rotation)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A BlueMap Wrapper to get data from a BlueMap Map",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/RyanStudioo/BlueMapMarkersWrapper",
"Issues": "https://github.com/RyanStudioo/BlueMapMarkersWrapper/issues"
},
"split_keywords": [
"bluemap",
" bluemapwrapper",
" bluemapwrapper.py"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ee8de71b7bd94fac3a0a733623d42f407c70fb775207417fa0a7bdde26d6ddca",
"md5": "f5926a14ae14d0e452438800e2ba0179",
"sha256": "80844fe8ed1e94c80b55b443a326d7e04ce3feba769244a12fbca844b831a939"
},
"downloads": -1,
"filename": "bluemapwrapper-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5926a14ae14d0e452438800e2ba0179",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14665,
"upload_time": "2025-07-31T06:50:27",
"upload_time_iso_8601": "2025-07-31T06:50:27.822991Z",
"url": "https://files.pythonhosted.org/packages/ee/8d/e71b7bd94fac3a0a733623d42f407c70fb775207417fa0a7bdde26d6ddca/bluemapwrapper-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b05b0c1975e90f1e4e1987528e30a202af6772e166f7787909d808bbcc769966",
"md5": "80f0e6324506edc50c827da7644d1033",
"sha256": "eeeafbc372860302e40860a4d15081b9075f776600713cc24851fd02e1d867ef"
},
"downloads": -1,
"filename": "bluemapwrapper-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "80f0e6324506edc50c827da7644d1033",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9590,
"upload_time": "2025-07-31T06:50:31",
"upload_time_iso_8601": "2025-07-31T06:50:31.364907Z",
"url": "https://files.pythonhosted.org/packages/b0/5b/0c1975e90f1e4e1987528e30a202af6772e166f7787909d808bbcc769966/bluemapwrapper-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 06:50:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RyanStudioo",
"github_project": "BlueMapMarkersWrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bluemapwrapper"
}
JSON
