geysermc


Namegeysermc JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/legopitstop/geysermc/
SummaryThe unofficial Python wrapper for geysermc.org
upload_time2024-09-23 20:01:20
maintainerNone
docs_urlNone
authorLegopitstop
requires_python>=3.6
licenseMIT
keywords minecraft geysermc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # geysermc

![Tests](https://github.com/legopitstop/geysermc/actions/workflows/tests.yml/badge.svg)
[![PyPI](https://img.shields.io/pypi/v/geysermc)](https://pypi.org/project/geysermc/)
[![Python](https://img.shields.io/pypi/pyversions/geysermc)](https://www.python.org/downloads//)
![Downloads](https://img.shields.io/pypi/dm/geysermc)
![Status](https://img.shields.io/pypi/status/geysermc)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Issues](https://img.shields.io/github/issues/legopitstop/geysermc)](https://github.com/legopitstop/geysermc/issues)

The unofficial Python wrapper for geysermc.org

## Installation

Install the module with pip:

```bat
pip3 install geysermc
```

Update existing installation: `pip3 install geysermc --upgrade`

## Links

- [Documentation](https://docs.lpsmods.dev/geysermc)
- [Source Code](https://github.com/legopitstop/geysermc)

## Requirements

| Name                                             | Description                                      |
| ------------------------------------------------ | ------------------------------------------------ |
| [`Pillow`](https://pypi.org/project/pillow/)     | Python Imaging Library (Fork)                    |
| [`requests`](https://pypi.org/project/requests/) | Requests is a simple, yet elegant, HTTP library. |
| [`pydantic`](https://pypi.org/project/pydantic/) | Data validation using Python type hints          |

## Features

- Get Microsoft xuid or gamertag.
- Download any geyser project.
- Get bedrock skin.

## Examples

Show bedrock player skin

```Python
from geysermc import GeyserMC

api = GeyserMC()

xuid = api.get_xuid('legopitstop')
skin = api.get_skin(xuid)
image = api.get_raw_texture(skin.texture_id)
image.show()
```

Download Geyser plugin

```Python
from geysermc import GeyserMC

api = GeyserMC()

with open('geyser-spigot.jar', 'wb') as fd:
    data = api.get_download('geyser', 'spigot')
    fd.write(data)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/legopitstop/geysermc/",
    "name": "geysermc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "Minecraft, GeyserMC",
    "author": "Legopitstop",
    "author_email": "contact@lpsmods.dev",
    "download_url": "https://files.pythonhosted.org/packages/50/e3/8029a16b128551aab6414872f5f6494a1ea87e1ab97acc12b99694c0558a/geysermc-1.1.0.tar.gz",
    "platform": null,
    "description": "# geysermc\n\n![Tests](https://github.com/legopitstop/geysermc/actions/workflows/tests.yml/badge.svg)\n[![PyPI](https://img.shields.io/pypi/v/geysermc)](https://pypi.org/project/geysermc/)\n[![Python](https://img.shields.io/pypi/pyversions/geysermc)](https://www.python.org/downloads//)\n![Downloads](https://img.shields.io/pypi/dm/geysermc)\n![Status](https://img.shields.io/pypi/status/geysermc)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![Issues](https://img.shields.io/github/issues/legopitstop/geysermc)](https://github.com/legopitstop/geysermc/issues)\n\nThe unofficial Python wrapper for geysermc.org\n\n## Installation\n\nInstall the module with pip:\n\n```bat\npip3 install geysermc\n```\n\nUpdate existing installation: `pip3 install geysermc --upgrade`\n\n## Links\n\n- [Documentation](https://docs.lpsmods.dev/geysermc)\n- [Source Code](https://github.com/legopitstop/geysermc)\n\n## Requirements\n\n| Name                                             | Description                                      |\n| ------------------------------------------------ | ------------------------------------------------ |\n| [`Pillow`](https://pypi.org/project/pillow/)     | Python Imaging Library (Fork)                    |\n| [`requests`](https://pypi.org/project/requests/) | Requests is a simple, yet elegant, HTTP library. |\n| [`pydantic`](https://pypi.org/project/pydantic/) | Data validation using Python type hints          |\n\n## Features\n\n- Get Microsoft xuid or gamertag.\n- Download any geyser project.\n- Get bedrock skin.\n\n## Examples\n\nShow bedrock player skin\n\n```Python\nfrom geysermc import GeyserMC\n\napi = GeyserMC()\n\nxuid = api.get_xuid('legopitstop')\nskin = api.get_skin(xuid)\nimage = api.get_raw_texture(skin.texture_id)\nimage.show()\n```\n\nDownload Geyser plugin\n\n```Python\nfrom geysermc import GeyserMC\n\napi = GeyserMC()\n\nwith open('geyser-spigot.jar', 'wb') as fd:\n    data = api.get_download('geyser', 'spigot')\n    fd.write(data)\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "The unofficial Python wrapper for geysermc.org",
    "version": "1.1.0",
    "project_urls": {
        "Documentation": "https://docs.lpsmods.dev/geysermc",
        "Download": "https://github.com/legopitstop/geysermc/releases",
        "Homepage": "https://github.com/legopitstop/geysermc/",
        "Source Code": "https://github.com/legopitstop/geysermc"
    },
    "split_keywords": [
        "minecraft",
        " geysermc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "50e38029a16b128551aab6414872f5f6494a1ea87e1ab97acc12b99694c0558a",
                "md5": "2dbd3181978c77df7e1c7dcd35bfbf89",
                "sha256": "86530249c6e32a913e4bcddaa47196dcb9fa3c9d33f9ca22deba823f213db368"
            },
            "downloads": -1,
            "filename": "geysermc-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2dbd3181978c77df7e1c7dcd35bfbf89",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 5917,
            "upload_time": "2024-09-23T20:01:20",
            "upload_time_iso_8601": "2024-09-23T20:01:20.340267Z",
            "url": "https://files.pythonhosted.org/packages/50/e3/8029a16b128551aab6414872f5f6494a1ea87e1ab97acc12b99694c0558a/geysermc-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-23 20:01:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "legopitstop",
    "github_project": "geysermc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "geysermc"
}
        
Elapsed time: 0.30442s