Skip to main content

A Python wrapper for the Mojang API and Minecraft website

Project description

PyPI version PyPI - Python Version

Read the Docs MIT License PyPI - Monthly Downloads

Documentation

Mojang is a Python package for accessing Mojang's services. This library can be used to convert UUIDs, get a profile's information, change your Minecraft username or skin, and much more.

There are 2 components to this package, which are imported in different ways:

  • Public API - Used to parse information about Minecraft profiles and more. Authentication is not required.
  • Client API - Used to login to a Mojang account and access it.

At the moment, the Client API only supports authenticating to a Minecraft account via Microsoft's authentication scheme, so your Minecraft account must already be migrated. Alternatively, you may authenticate to a Mojang account directly with a Bearer token.

Installation

Python 3.7 or higher is required.

The easiest way to install the library is using pip. Just run the following console command:

python -m pip install mojang

Public API Quickstart

from mojang import API

# Create a Public API instance
api = API()

uuid = api.get_uuid("Notch")

if not uuid:
    print("Notch is not a taken username.")
else:
    print(f"Notch's UUID is {uuid}")

    profile = api.get_profile(uuid)
    print(f"Notch's skin URL is {profile.skin_url}")
    print(f"Notch's skin variant is {profile.skin_variant}")
    print(f"Notch's cape URL is {profile.cape_url}")

Client API Quickstart

To log into a Mojang account, the account must already be migrated to Microsoft. This means that you will be using your Microsoft credentials to login.

from mojang import Client

client = Client("YOUR_MICROSOFT_EMAIL", "YOUR_PASSWORD")

# Get the account's profile information
profile = client.get_profile()

print(profile.id)
print(profile.name)

for skin in profile.skins:
    print(skin.id)
    print(skin.enabled)
    print(skin.url)
    print(skin.variant)

Alternatively, supply a Bearer token and skip the Microsoft authentication process.

client = Client(bearer_token="MOJANG_BEARER_TOKEN_HERE")

If authentication fails, such as due to an incorrect email or password, a LoginFailure exception will occur.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mojang-1.1.0.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

mojang-1.1.0-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file mojang-1.1.0.tar.gz.

File metadata

  • Download URL: mojang-1.1.0.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for mojang-1.1.0.tar.gz
Algorithm Hash digest
SHA256 08c2d6156e8c1d60afd3c0cef60a9198b4b21bdd8a3d2b15a0b309fb122fbbac
MD5 688432e5472d839fc942099628bd96e1
BLAKE2b-256 d6a15043c107234ea09cde5f575a7cb8b267ab63a0bb266d828aa9468839378b

See more details on using hashes here.

File details

Details for the file mojang-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: mojang-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for mojang-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58dcd826ebbb49aa18d97bff9c2cf4ed4bcbba4c64bfd6630ece1ce33359d864
MD5 c8dd7bd2196eba4f4e2c2f895b809826
BLAKE2b-256 d3bea3af5b5cd9e827c68cd2a4997cd65587052c7b3ed76ba682c48434edd502

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page