bolt


Namebolt JSON
Version 0.48.0 PyPI version JSON
download
home_pagehttps://github.com/mcbeet/bolt
SummarySupercharge Minecraft commands with Python
upload_time2024-04-29 00:07:07
maintainerNone
docs_urlNone
authorValentin Berlier
requires_python<4.0,>=3.10
licenseMIT
keywords beet minecraft minecraft-commands scripting-language mcfunction
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bolt

[![GitHub Actions](https://github.com/mcbeet/bolt/workflows/CI/badge.svg)](https://github.com/mcbeet/bolt/actions)
[![PyPI](https://img.shields.io/pypi/v/bolt.svg)](https://pypi.org/project/bolt/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/bolt.svg)](https://pypi.org/project/bolt/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Discord](https://img.shields.io/discord/900530660677156924?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/98MdSGMm8j)

> Supercharge Minecraft commands with Python.

```python
infinite_invisibility = {
    Id: 14,
    Duration: 999999,
    Amplifier: 1,
    ShowParticles: false,
}

def summon_chicken_army(n):
    for i in range(n):
        summon chicken ~i ~ ~ {
            Tags: [f"quack{i}"],
            IsChickenJockey: true,
            Passengers: [{
                id: zombie,
                IsBaby: true,
                ActiveEffects: [infinite_invisibility]
            }]
        }

say Go forth, my minions!
summon_chicken_army(16)
```

## Installation

The package can be installed with `pip`.

```bash
$ pip install bolt
```

## Contributing

Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses [`poetry`](https://python-poetry.org/).

```bash
$ poetry install
```

You can run the tests with `poetry run pytest`.

```bash
$ poetry run pytest
```

The project must type-check with [`pyright`](https://github.com/microsoft/pyright). If you're using VSCode the [`pylance`](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) extension should report diagnostics automatically. You can also install the type-checker locally with `npm install` and run it from the command-line.

```bash
$ npm run watch
$ npm run check
```

The code follows the [`black`](https://github.com/psf/black) code style. Import statements are sorted with [`isort`](https://pycqa.github.io/isort/).

```bash
$ poetry run isort bolt tests
$ poetry run black bolt tests
$ poetry run black --check bolt tests
```

---

License - [MIT](https://github.com/mcbeet/bolt/blob/main/LICENSE)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mcbeet/bolt",
    "name": "bolt",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "beet, minecraft, minecraft-commands, scripting-language, mcfunction",
    "author": "Valentin Berlier",
    "author_email": "berlier.v@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/54/14/5224cedff87ac2cd3386d4977516809e9faa9d99c780cb0fe7c2c80d1632/bolt-0.48.0.tar.gz",
    "platform": null,
    "description": "# Bolt\n\n[![GitHub Actions](https://github.com/mcbeet/bolt/workflows/CI/badge.svg)](https://github.com/mcbeet/bolt/actions)\n[![PyPI](https://img.shields.io/pypi/v/bolt.svg)](https://pypi.org/project/bolt/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/bolt.svg)](https://pypi.org/project/bolt/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![Discord](https://img.shields.io/discord/900530660677156924?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/98MdSGMm8j)\n\n> Supercharge Minecraft commands with Python.\n\n```python\ninfinite_invisibility = {\n    Id: 14,\n    Duration: 999999,\n    Amplifier: 1,\n    ShowParticles: false,\n}\n\ndef summon_chicken_army(n):\n    for i in range(n):\n        summon chicken ~i ~ ~ {\n            Tags: [f\"quack{i}\"],\n            IsChickenJockey: true,\n            Passengers: [{\n                id: zombie,\n                IsBaby: true,\n                ActiveEffects: [infinite_invisibility]\n            }]\n        }\n\nsay Go forth, my minions!\nsummon_chicken_army(16)\n```\n\n## Installation\n\nThe package can be installed with `pip`.\n\n```bash\n$ pip install bolt\n```\n\n## Contributing\n\nContributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses [`poetry`](https://python-poetry.org/).\n\n```bash\n$ poetry install\n```\n\nYou can run the tests with `poetry run pytest`.\n\n```bash\n$ poetry run pytest\n```\n\nThe project must type-check with [`pyright`](https://github.com/microsoft/pyright). If you're using VSCode the [`pylance`](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) extension should report diagnostics automatically. You can also install the type-checker locally with `npm install` and run it from the command-line.\n\n```bash\n$ npm run watch\n$ npm run check\n```\n\nThe code follows the [`black`](https://github.com/psf/black) code style. Import statements are sorted with [`isort`](https://pycqa.github.io/isort/).\n\n```bash\n$ poetry run isort bolt tests\n$ poetry run black bolt tests\n$ poetry run black --check bolt tests\n```\n\n---\n\nLicense - [MIT](https://github.com/mcbeet/bolt/blob/main/LICENSE)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Supercharge Minecraft commands with Python",
    "version": "0.48.0",
    "project_urls": {
        "Documentation": "https://github.com/mcbeet/bolt",
        "Homepage": "https://github.com/mcbeet/bolt",
        "Repository": "https://github.com/mcbeet/bolt"
    },
    "split_keywords": [
        "beet",
        " minecraft",
        " minecraft-commands",
        " scripting-language",
        " mcfunction"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0c7b35cbedefce0d06de65c0f795941f910d9dceb37a0ec9e47f793bdd4144e2",
                "md5": "63b709f62a2255fb0b42fbdc1e97c8ea",
                "sha256": "7fd79b531837a9cc83a477dbfe851c4116686df542e51b2fcc07672a38739aa9"
            },
            "downloads": -1,
            "filename": "bolt-0.48.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "63b709f62a2255fb0b42fbdc1e97c8ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 59325,
            "upload_time": "2024-04-29T00:07:02",
            "upload_time_iso_8601": "2024-04-29T00:07:02.590389Z",
            "url": "https://files.pythonhosted.org/packages/0c/7b/35cbedefce0d06de65c0f795941f910d9dceb37a0ec9e47f793bdd4144e2/bolt-0.48.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "54145224cedff87ac2cd3386d4977516809e9faa9d99c780cb0fe7c2c80d1632",
                "md5": "583a2dc96d8fca60b65085f292187be1",
                "sha256": "62e56ca90a39d88ed902a0377fff303abaedfdeb8a8e1b45d7353c3396438b48"
            },
            "downloads": -1,
            "filename": "bolt-0.48.0.tar.gz",
            "has_sig": false,
            "md5_digest": "583a2dc96d8fca60b65085f292187be1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 53431,
            "upload_time": "2024-04-29T00:07:07",
            "upload_time_iso_8601": "2024-04-29T00:07:07.224397Z",
            "url": "https://files.pythonhosted.org/packages/54/14/5224cedff87ac2cd3386d4977516809e9faa9d99c780cb0fe7c2c80d1632/bolt-0.48.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-29 00:07:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mcbeet",
    "github_project": "bolt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "bolt"
}
        
Elapsed time: 0.23725s