wicked-expressions


Namewicked-expressions JSON
Version 1.6.2 PyPI version JSON
download
home_pagehttps://github.com/reapermc/wicked-expressions
SummaryExtension of bolt-expressions written in Bolt.
upload_time2023-12-03 23:00:19
maintainer
docs_urlNone
authorYeti
requires_python>=3.12,<4.0
licenseMIT
keywords beet bolt minecraft minecraft-commands mcfunction
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # wicked-expressions

[![GitHub Actions](https://github.com/reapermc/wicked-expressions/workflows/CI/badge.svg)](https://github.com/reapermc/wicked-expressions/actions)

> Extension of bolt-expressions written in Bolt.


## Introduction

This is an extension of the [bolt-expressions](https://github.com/rx-modules/bolt-expressions) package. I highly recommend getting accustom to the original before using this one. This package is meant to build upon it by adding more functionality.


```py
from wicked_expressions:api import Scoreboard, Var, Float

foo = Scoreboard('demo')['$foo']
bar = Var(Float, 3.14159)

foo = 123
data_0 = 30

if foo == 1:
    tellraw @a "foo == 1"
else:
    tellraw @a "foo != 1"

if bar == 3.14159:
    tellraw @a "yes :3"
else:
    tellraw @a "no :<"
```

## Installation

```bash
pip install wicked_expressions
```

## Getting started

The library is designed to be used within any `bolt` script (either a `.mcfunction` or `bolt` file) inside a `bolt` enabled project.

```yaml
require:
    - bolt
    - wicked_expressions

pipeline:
    - mecha
```

Once you've required `bolt` and `wicked_expressions`, you are able to import the package's `api` module directly inside your bolt script.

Most of the imports come from the `wicked_expressions:api` module as shown below.

```py
from wicked_expressions:api import Scoreboard
```

Now you're free to use the API. Use simple and complex expressions, compare expressions and have access to many more features of the library!


## Documentation

Docs available [here](./docs/home.md).

## Features

- Most if not all the functionality of [bolt-expressions](https://github.com/rx-modules/bolt-expressions).
- Built in score & data comparison using python's comparison operators.
- Useful functions and methods especially for bolt library developers such as `.store()` and `.get()`.
- Anonymous runtime variables.
- DataStash feature allowing per-entity data.

---

License - [MIT](https://github.com/reapermc/wicked-expressions/blob/main/LICENSE)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/reapermc/wicked-expressions",
    "name": "wicked-expressions",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.12,<4.0",
    "maintainer_email": "",
    "keywords": "beet,bolt,minecraft,minecraft-commands,mcfunction",
    "author": "Yeti",
    "author_email": "arcticyeti1@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c0/7b/a3ea33a5b923ebe2b4153786284dd9b94ce972d141fff16181628261f589/wicked_expressions-1.6.2.tar.gz",
    "platform": null,
    "description": "# wicked-expressions\n\n[![GitHub Actions](https://github.com/reapermc/wicked-expressions/workflows/CI/badge.svg)](https://github.com/reapermc/wicked-expressions/actions)\n\n> Extension of bolt-expressions written in Bolt.\n\n\n## Introduction\n\nThis is an extension of the [bolt-expressions](https://github.com/rx-modules/bolt-expressions) package. I highly recommend getting accustom to the original before using this one. This package is meant to build upon it by adding more functionality.\n\n\n```py\nfrom wicked_expressions:api import Scoreboard, Var, Float\n\nfoo = Scoreboard('demo')['$foo']\nbar = Var(Float, 3.14159)\n\nfoo = 123\ndata_0 = 30\n\nif foo == 1:\n    tellraw @a \"foo == 1\"\nelse:\n    tellraw @a \"foo != 1\"\n\nif bar == 3.14159:\n    tellraw @a \"yes :3\"\nelse:\n    tellraw @a \"no :<\"\n```\n\n## Installation\n\n```bash\npip install wicked_expressions\n```\n\n## Getting started\n\nThe library is designed to be used within any `bolt` script (either a `.mcfunction` or `bolt` file) inside a `bolt` enabled project.\n\n```yaml\nrequire:\n    - bolt\n    - wicked_expressions\n\npipeline:\n    - mecha\n```\n\nOnce you've required `bolt` and `wicked_expressions`, you are able to import the package's `api` module directly inside your bolt script.\n\nMost of the imports come from the `wicked_expressions:api` module as shown below.\n\n```py\nfrom wicked_expressions:api import Scoreboard\n```\n\nNow you're free to use the API. Use simple and complex expressions, compare expressions and have access to many more features of the library!\n\n\n## Documentation\n\nDocs available [here](./docs/home.md).\n\n## Features\n\n- Most if not all the functionality of [bolt-expressions](https://github.com/rx-modules/bolt-expressions).\n- Built in score & data comparison using python's comparison operators.\n- Useful functions and methods especially for bolt library developers such as `.store()` and `.get()`.\n- Anonymous runtime variables.\n- DataStash feature allowing per-entity data.\n\n---\n\nLicense - [MIT](https://github.com/reapermc/wicked-expressions/blob/main/LICENSE)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Extension of bolt-expressions written in Bolt.",
    "version": "1.6.2",
    "project_urls": {
        "Homepage": "https://github.com/reapermc/wicked-expressions"
    },
    "split_keywords": [
        "beet",
        "bolt",
        "minecraft",
        "minecraft-commands",
        "mcfunction"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2a4c34d26e2b5ca99d3edc7c781eb75029c0b9b93ef3c31a697e80e531065db5",
                "md5": "914b9641c8701185b8d68b03525f41fa",
                "sha256": "21fdc516fe6c0d6d9cab999dc5d5e8fc1559e6795feedd02f188b20de17d7a68"
            },
            "downloads": -1,
            "filename": "wicked_expressions-1.6.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "914b9641c8701185b8d68b03525f41fa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12,<4.0",
            "size": 18821,
            "upload_time": "2023-12-03T23:00:17",
            "upload_time_iso_8601": "2023-12-03T23:00:17.172288Z",
            "url": "https://files.pythonhosted.org/packages/2a/4c/34d26e2b5ca99d3edc7c781eb75029c0b9b93ef3c31a697e80e531065db5/wicked_expressions-1.6.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c07ba3ea33a5b923ebe2b4153786284dd9b94ce972d141fff16181628261f589",
                "md5": "7cf3e6e7084425a11fc466e27e5ffc5e",
                "sha256": "736aa8b0fed1fe09282c77b61c2308e9635b0436a176b31d9972ee068cdcccb0"
            },
            "downloads": -1,
            "filename": "wicked_expressions-1.6.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7cf3e6e7084425a11fc466e27e5ffc5e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12,<4.0",
            "size": 14143,
            "upload_time": "2023-12-03T23:00:19",
            "upload_time_iso_8601": "2023-12-03T23:00:19.401992Z",
            "url": "https://files.pythonhosted.org/packages/c0/7b/a3ea33a5b923ebe2b4153786284dd9b94ce972d141fff16181628261f589/wicked_expressions-1.6.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-03 23:00:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "reapermc",
    "github_project": "wicked-expressions",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "wicked-expressions"
}
        
Elapsed time: 0.16645s