Skip to main content

Python client for the Py-Ritone Baritone bridge

Project description

pyritone

pyritone is the Python client for the Py-Ritone Fabric bridge.

Install

pip install pyritone

Fastest Working Sync Example

from pyritone import PyritoneClient

with PyritoneClient() as client:
    print(client.ping())
    dispatch = client.build_file("schematics/base.schem", 100, 70, 100)
    print(dispatch)

Fastest Working Async Example

import asyncio
from pyritone import AsyncPyritoneClient


async def main() -> None:
    client = AsyncPyritoneClient()
    await client.connect()
    try:
        print(await client.ping())
        dispatch = await client.build_file("schematics/base.schem", 100, 70, 100)
        print(dispatch)
    finally:
        await client.close()


asyncio.run(main())

Docs

  • Full docs index: python/docs/index.md
  • Quickstart: python/docs/quickstart.md
  • Sync client guide: python/docs/sync-client.md
  • Async client guide: python/docs/async-client.md
  • Settings API: python/docs/settings-api.md
  • Tasks/events/waiting: python/docs/tasks-events-and-waiting.md
  • Errors/troubleshooting: python/docs/errors-and-troubleshooting.md
  • CLI usage: python/docs/cli.md
  • Command docs:
    • python/docs/commands/navigation.md
    • python/docs/commands/world.md
    • python/docs/commands/build.md
    • python/docs/commands/control.md
    • python/docs/commands/info.md
    • python/docs/commands/waypoints.md
    • python/docs/commands/aliases.md
  • Raw Baritone appendix: python/docs/baritone-commands.md

Public API Map

  • Clients:
    • PyritoneClient
    • AsyncPyritoneClient
  • Low-level methods:
    • ping, status_get, execute, cancel, next_event, wait_for_task
  • Command wrappers:
    • All top-level Baritone commands exposed as methods.
  • Local schematic helpers:
    • build_file(path, *coords, base_dir=None)
    • build_file_wait(path, *coords, base_dir=None)
  • Settings namespace:
    • Sync: client.settings.allowPlace = True
    • Async: await client.settings.allowPlace.set(True)

Auto-Discovery (Zero-Setup)

By default, pyritone discovers bridge metadata from:

  • <minecraft>/config/pyritone_bridge/bridge-info.json

Override precedence:

  1. Explicit constructor args
  2. Environment variables: PYRITONE_BRIDGE_INFO, PYRITONE_TOKEN, PYRITONE_HOST, PYRITONE_PORT
  3. Auto-discovered bridge info file

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

pyritone-0.1.2.tar.gz (50.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyritone-0.1.2-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file pyritone-0.1.2.tar.gz.

File metadata

  • Download URL: pyritone-0.1.2.tar.gz
  • Upload date:
  • Size: 50.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyritone-0.1.2.tar.gz
Algorithm Hash digest
SHA256 dfb1a27be953db7d12309153efebf36e4febf8acd258262e0b019596c4f6136a
MD5 7de3c2fc93bbaa9b5234ae89eb810ee7
BLAKE2b-256 402a349178b0d0bfe13b7d8969e652d00e5aae7549616be87ff666d5599c0043

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyritone-0.1.2.tar.gz:

Publisher: publish.yml on GSstarGamer/Py-Ritone

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyritone-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pyritone-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 32.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyritone-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 76d69e0a084a73c4b19de66da8b69fff8ecaa7ee45ab1fc4573e7a95a447794c
MD5 d0de5ae3e66b198c240fee754d774ea0
BLAKE2b-256 60e8426db0bcad14d6b44c8a90b750ea919dd6d4877b887df05d6d6eac37a3c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyritone-0.1.2-py3-none-any.whl:

Publisher: publish.yml on GSstarGamer/Py-Ritone

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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