ChalkCli


NameChalkCli JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/ishanoshada/ChalkCli
SummaryA Python package for terminal text styling and coloring.
upload_time2023-11-26 08:42:40
maintainer
docs_urlNone
authorIshan Oshada
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ChalkCli

ChalkCli is a Python package for terminal text styling and coloring. Add vibrant colors, formatting, and animations to your terminal output with ease.

## Installation

You can install ChalkCli using pip:

```bash
pip install ChalkCli
```

## Usage

```python
from ChalkCli import ChalkCli

# Example usage
text = "Hello, ChalkCli!"
styled_text = ChalkCli.format_text(text, styles=[ChalkCli.BOLD, ChalkCli.BLUE])
print(styled_text)
```

## Features

- Stylish text formatting
- Colorful output for better visibility
- Text animations for a dynamic terminal experience


| Function | Description | Example Usage | Arguments |
| --- | --- | --- | --- |
| `format_text` | Formats text with styles and color | `ChalkCli.format_text("Hello", styles=[ChalkCli.BOLD, ChalkCli.RED])` | `text (str)`, `styles (list of str)`, `color (str)` |
| `colorized_banner` | Creates a colorized banner | `ChalkCli.colorized_banner("Welcome", styles=[ChalkCli.BOLD], color=ChalkCli.BLUE)` | `text (str)`, `styles (list of str)`, `color (str)`, `banner_char (str)` |
| `rainbow_text` | Creates rainbow-colored text | `ChalkCli.rainbow_text("Hello, Rainbow!")` | `text (str)` |
| `create_table` | Creates a table with a header and data | `ChalkCli.create_table(["Name", "Age"], [["Alice", 25], ["Bob", 30]])` | `header (list of str)`, `data (list of lists)` |
| `typewriter_text` | Outputs text with a typewriter effect | `ChalkCli.typewriter_text("Hello, Typewriter!")` | `text (str)`, `delay (float)` |
| `pulsating_text` | Outputs text with a pulsating effect | `ChalkCli.pulsating_text("Pulsating")` | `text (str)`, `period (float)` |
| `blinking_text` | Outputs text with a blinking effect | `ChalkCli.blinking_text("Blinking")` | `text (str)`, `blink_duration (float)` |
| `rotating_text` | Outputs text with a rotating effect | `ChalkCli.rotating_text("Rotating", rotations=3)` | `text (str)`, `rotations (int)` |
| `countdown` | Displays a countdown | `ChalkCli.countdown(5)` | `seconds (int)` |
| `progress_bar` | Displays a progress bar | `ChalkCli.progress_bar(0.75)` | `progress (float)`, `length (int)` |
| `random_color_text` | Outputs text with random colors | `ChalkCli.random_color_text("Random Colors")` | `text (str)` |
| `scrolling_text` | Scrolls text horizontally | `ChalkCli.scrolling_text("Scrolling Text", scroll_speed=0.1)` | `text (str)`, `scroll_speed (float)` |
| `center_text` | Centers text within a specified width | `ChalkCli.center_text("Centered Text", width=50)` | `text (str)`, `width (int)` |
| `fading_text` | Outputs text with a fading effect | `ChalkCli.fading_text("Fading Text", fade_duration=5)` | `text (str)`, `fade_duration (float)` |


## Examples

### Rainbow Text

```python
from ChalkCli import ChalkCli

text = "Rainbow Text"
rainbow_text = ChalkCli.rainbow_text(text)
print(rainbow_text)
```

### Table Creation

```python
from ChalkCli import ChalkCli

header = ["Name", "Age", "Country"]
data = [
    ["Alice", "25", "USA"],
    ["Bob", "30", "Canada"],
    ["Charlie", "22", "UK"],
]

table = ChalkCli.create_table(header, data)
print(table)
```

**Repository Views** ![Views](https://profile-counter.glitch.me/ChalkCli/count.svg)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ishanoshada/ChalkCli",
    "name": "ChalkCli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Ishan Oshada",
    "author_email": "Ishan.kodithuwakku.official@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1b/d3/deacc52b3a871937e46e53e51e6b6f70b4e03c1977a1f7129fcfd9597b2e/ChalkCli-0.1.0.tar.gz",
    "platform": null,
    "description": "# ChalkCli\n\nChalkCli is a Python package for terminal text styling and coloring. Add vibrant colors, formatting, and animations to your terminal output with ease.\n\n## Installation\n\nYou can install ChalkCli using pip:\n\n```bash\npip install ChalkCli\n```\n\n## Usage\n\n```python\nfrom ChalkCli import ChalkCli\n\n# Example usage\ntext = \"Hello, ChalkCli!\"\nstyled_text = ChalkCli.format_text(text, styles=[ChalkCli.BOLD, ChalkCli.BLUE])\nprint(styled_text)\n```\n\n## Features\n\n- Stylish text formatting\n- Colorful output for better visibility\n- Text animations for a dynamic terminal experience\n\n\n| Function | Description | Example Usage | Arguments |\n| --- | --- | --- | --- |\n| `format_text` | Formats text with styles and color | `ChalkCli.format_text(\"Hello\", styles=[ChalkCli.BOLD, ChalkCli.RED])` | `text (str)`, `styles (list of str)`, `color (str)` |\n| `colorized_banner` | Creates a colorized banner | `ChalkCli.colorized_banner(\"Welcome\", styles=[ChalkCli.BOLD], color=ChalkCli.BLUE)` | `text (str)`, `styles (list of str)`, `color (str)`, `banner_char (str)` |\n| `rainbow_text` | Creates rainbow-colored text | `ChalkCli.rainbow_text(\"Hello, Rainbow!\")` | `text (str)` |\n| `create_table` | Creates a table with a header and data | `ChalkCli.create_table([\"Name\", \"Age\"], [[\"Alice\", 25], [\"Bob\", 30]])` | `header (list of str)`, `data (list of lists)` |\n| `typewriter_text` | Outputs text with a typewriter effect | `ChalkCli.typewriter_text(\"Hello, Typewriter!\")` | `text (str)`, `delay (float)` |\n| `pulsating_text` | Outputs text with a pulsating effect | `ChalkCli.pulsating_text(\"Pulsating\")` | `text (str)`, `period (float)` |\n| `blinking_text` | Outputs text with a blinking effect | `ChalkCli.blinking_text(\"Blinking\")` | `text (str)`, `blink_duration (float)` |\n| `rotating_text` | Outputs text with a rotating effect | `ChalkCli.rotating_text(\"Rotating\", rotations=3)` | `text (str)`, `rotations (int)` |\n| `countdown` | Displays a countdown | `ChalkCli.countdown(5)` | `seconds (int)` |\n| `progress_bar` | Displays a progress bar | `ChalkCli.progress_bar(0.75)` | `progress (float)`, `length (int)` |\n| `random_color_text` | Outputs text with random colors | `ChalkCli.random_color_text(\"Random Colors\")` | `text (str)` |\n| `scrolling_text` | Scrolls text horizontally | `ChalkCli.scrolling_text(\"Scrolling Text\", scroll_speed=0.1)` | `text (str)`, `scroll_speed (float)` |\n| `center_text` | Centers text within a specified width | `ChalkCli.center_text(\"Centered Text\", width=50)` | `text (str)`, `width (int)` |\n| `fading_text` | Outputs text with a fading effect | `ChalkCli.fading_text(\"Fading Text\", fade_duration=5)` | `text (str)`, `fade_duration (float)` |\n\n\n## Examples\n\n### Rainbow Text\n\n```python\nfrom ChalkCli import ChalkCli\n\ntext = \"Rainbow Text\"\nrainbow_text = ChalkCli.rainbow_text(text)\nprint(rainbow_text)\n```\n\n### Table Creation\n\n```python\nfrom ChalkCli import ChalkCli\n\nheader = [\"Name\", \"Age\", \"Country\"]\ndata = [\n    [\"Alice\", \"25\", \"USA\"],\n    [\"Bob\", \"30\", \"Canada\"],\n    [\"Charlie\", \"22\", \"UK\"],\n]\n\ntable = ChalkCli.create_table(header, data)\nprint(table)\n```\n\n**Repository Views** ![Views](https://profile-counter.glitch.me/ChalkCli/count.svg)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Python package for terminal text styling and coloring.",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/ishanoshada/ChalkCli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1bd3deacc52b3a871937e46e53e51e6b6f70b4e03c1977a1f7129fcfd9597b2e",
                "md5": "6eea6fcb7cf3d2c2e714194d82499d71",
                "sha256": "a22ed0721e92383258aa8e4366cbada25807a19d2e7445d1da8c1f538f4fc92d"
            },
            "downloads": -1,
            "filename": "ChalkCli-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6eea6fcb7cf3d2c2e714194d82499d71",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6423,
            "upload_time": "2023-11-26T08:42:40",
            "upload_time_iso_8601": "2023-11-26T08:42:40.806895Z",
            "url": "https://files.pythonhosted.org/packages/1b/d3/deacc52b3a871937e46e53e51e6b6f70b4e03c1977a1f7129fcfd9597b2e/ChalkCli-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-26 08:42:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ishanoshada",
    "github_project": "ChalkCli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "chalkcli"
}
        
Elapsed time: 0.20210s