hueprint

Name	hueprint JSON
Version	1.0.1 JSON
	download
home_page	https://github.com/matheusvilano/hueprint.git
Summary	A simple package that enables coloured output in Python console applications.
upload_time	2023-09-10 21:42:30
maintainer
docs_url	None
author	Matheus Vilano
requires_python	>=3.3
license	MIT
keywords	colour color hue console output print terminal text style format effect ansi escape sequence
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Hueprint

## Summary

Hueprint is a simple package that allows the usage of colour and text effects in Python console applications.

## Data Types

The package introduces two simple enums: `EColour` and `EEffect`.

## Functions

- `cprint`: allows using `EColour` and `EEffect` for easy text style customization.
- `sprint`: "success" style; green, no effect.
- `eprint`: "error" style; red, no effect.
- `wprint`: "warning" style; yellow, no effect.
- `nprint`: "notification" style; blue, no effect.
- `iprint`: a wrapper to the `pprint` function (from the `pprint` package).

## Example

`cprint` is the only function that differs from `print` in terms of number or arguments required, so this example will focus on that:

```python
    from hueprint import cprint
    from hueprint.types import EColour, EEffect

    text = "Hello, World!"
    colour = EColour.CYAN
    effect = EEffect.ITALIC

    cprint(text, colour, effect)  # This will print the specified text in cyan and italic.
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/matheusvilano/hueprint.git",
    "name": "hueprint",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.3",
    "maintainer_email": "",
    "keywords": "colour color hue console output print terminal text style format effect ANSI escape sequence",
    "author": "Matheus Vilano",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/dd/b1/dc83717e7c5914b29df5b0c565fb514b755344303ab0da28684c5d243442/hueprint-1.0.1.tar.gz",
    "platform": null,
    "description": "# Hueprint\r\n\r\n## Summary\r\n\r\nHueprint is a simple package that allows the usage of colour and text effects in Python console applications.\r\n\r\n## Data Types\r\n\r\nThe package introduces two simple enums: `EColour` and `EEffect`.\r\n\r\n## Functions\r\n\r\n- `cprint`: allows using `EColour` and `EEffect` for easy text style customization.\r\n- `sprint`: \"success\" style; green, no effect.\r\n- `eprint`: \"error\" style; red, no effect.\r\n- `wprint`: \"warning\" style; yellow, no effect.\r\n- `nprint`: \"notification\" style; blue, no effect.\r\n- `iprint`: a wrapper to the `pprint` function (from the `pprint` package).\r\n\r\n## Example\r\n\r\n`cprint` is the only function that differs from `print` in terms of number or arguments required, so this example will focus on that:\r\n\r\n```python\r\n    from hueprint import cprint\r\n    from hueprint.types import EColour, EEffect\r\n\r\n    text = \"Hello, World!\"\r\n    colour = EColour.CYAN\r\n    effect = EEffect.ITALIC\r\n\r\n    cprint(text, colour, effect)  # This will print the specified text in cyan and italic.\r\n```\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple package that enables coloured output in Python console applications.",
    "version": "1.0.1",
    "project_urls": {
        "Author Website": "https://www.matheusvilano.com/",
        "Git Repository": "https://github.com/matheusvilano/hueprint",
        "Homepage": "https://github.com/matheusvilano/hueprint.git"
    },
    "split_keywords": [
        "colour",
        "color",
        "hue",
        "console",
        "output",
        "print",
        "terminal",
        "text",
        "style",
        "format",
        "effect",
        "ansi",
        "escape",
        "sequence"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ddb1dc83717e7c5914b29df5b0c565fb514b755344303ab0da28684c5d243442",
                "md5": "27904fcfc6828530e14aa069576ef598",
                "sha256": "831123e73308f43e04d57ce35d2dc04964635f5093672553ee5f20ab83ab6772"
            },
            "downloads": -1,
            "filename": "hueprint-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "27904fcfc6828530e14aa069576ef598",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.3",
            "size": 4210,
            "upload_time": "2023-09-10T21:42:30",
            "upload_time_iso_8601": "2023-09-10T21:42:30.599937Z",
            "url": "https://files.pythonhosted.org/packages/dd/b1/dc83717e7c5914b29df5b0c565fb514b755344303ab0da28684c5d243442/hueprint-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-10 21:42:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "matheusvilano",
    "github_project": "hueprint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "hueprint"
}