Skip to main content

A pytest plugin for running tests against Minecraft releases

Project description


Build Status PyPI PyPI - Python Version

A pytest plugin for running tests against Minecraft releases.

The plugin automatically downloads the latest version of the Minecraft client into the pytest cache. The provided fixtures can also extract the vanilla resource pack and data pack on demand.


The package can be installed with pip.

$ pip install pytest-minecraft


Downloading the Minecraft client takes a few seconds so the tests that use the fixtures provided by the plugin will be skipped unless explicitly enabled with a command-line flag. The --minecraft-latest flag will enable the tests and run them against the latest stable release.

$ pytest --minecraft-latest

You can also use the --minecraft-snapshot flag to test against the latest snapshot. Both flags can be specified at the same time to run the tests against both stable and snapshot releases.

$ pytest --minecraft-latest --minecraft-snapshot


  • The minecraft_client_jar fixture returns the path to the downloaded Minecraft client as a pathlib.Path instance.

    def test_with_client(minecraft_client_jar):
        assert == "client.jar"
        with ZipFile(minecraft_client_jar) as client:
            assert len(client.namelist()) > 10_000
  • The minecraft_resource_pack fixture returns the path to the extracted vanilla resource pack as a pathlib.Path instance.

    def test_with_resource_pack(minecraft_resource_pack):
        assert == "resource_pack"
        assert (minecraft_resource_pack / "assets" / "minecraft" / "textures").is_dir()
  • The minecraft_data_pack fixture returns the path to the extracted vanilla data pack as a pathlib.Path instance.

    def test_with_data_pack(minecraft_data_pack):
        assert == "data_pack"
        assert (minecraft_data_pack / "data" / "minecraft" / "loot_tables").is_dir()


Contributions are welcome. This project uses poetry.

$ poetry install

You can run the tests with poetry run pytest.

$ poetry run pytest

The code follows the black code style.

$ poetry run black .

License - MIT

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

pytest-minecraft-0.2.0.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

pytest_minecraft-0.2.0-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

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