| Name | ColorsAndStyles JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | A basic package that makes it easy to add color and styles to your terminal. |
| upload_time | 2023-04-08 07:44:43 |
| maintainer | |
| docs_url | None |
| author | QwertyQwerty |
| requires_python | |
| license | MIT |
| keywords |
color
style
ansi
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Colors And Styles
A basic package that makes it easy to add color and styles to your terminal.
## How to use
First go to the terminal and run `pip install ColorsAndStyles`. Then create a Python file and paste this code in it:
```python
from ColorsAndStyles import Color, Style, clear, RESET_ALL
```
`RESET_ALL` is a string with the ANSI escape code to reset all colors and styles.
`clear` is a function that... Clears and flushes the terminal.
### Color
`Color` has 3 classes: `RGB`, `Foreground`, and `Background`.
As a string, an `RGB` value returns an ANSI color code.
- `RGB` requires 4 arguments:
| Parameter | Description |
|----------------|-------------------------------------------------------------------------------------------------------------------|
| `red` | The red value of the RGB. |
| `green` | The green value of the RGB. |
| `blue` | The blue value of the RGB. |
| `isForeground` | Returns a foreground ANSI color code as a string if `True`. Else returns a background ANSI color code. (Optional) |
- `Foreground` has 8 class variables: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, and `RESET`. They are assigned to their respective ANSI color codes. To use these color codes, simply concatenate them with a string like so:
```python
print(f"{Color.Foreground.RED}This text is red.{Color.Foreground.RESET}")
```
- `Background` has 9 class variables: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE` and `RESET`. To use them, just concatenate them to a string just like `Foreground`'s class variables:
```python
print(f"{Color.Background.GREEN}This text is green.{Color.Background.RESET}")
```
### Style
`Style` has 6 class variables: `BOLD`, `DIM`, `ITALICS`, `UNDERLINE`, `STRIKETHROUGH`, and `RESET`. Like the classes in `Color`, they are assigned to their respective ANSI escape codes. Concatenate them to strings to use them:
```python
print(f"{Style.BOLD}This text is bold.{Style.RESET}")
```
# Change Log
## 0.0.5 (4/8/2023)
- Added documentation for the `clear` function in the README.
## 0.0.4 (4/8/2023)
- Added a `clear` function
- Slightly changed the README
## 0.0.3 (4/2/2023)
- Moved all the code into one file
## 0.0.2 (4/2/2023)
- Slightly changed the README
## 0.0.1 (4/2/2023)
- First release
Raw data
{
"_id": null,
"home_page": "",
"name": "ColorsAndStyles",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "color,style,ansi",
"author": "QwertyQwerty",
"author_email": "personqwertyperson88@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f4/a2/e0174aa075a6aed23e79babc5ab822ae2da264fe7f9ba9e64a3ae342609e/ColorsAndStyles-0.0.5.tar.gz",
"platform": null,
"description": "# Colors And Styles\n\nA basic package that makes it easy to add color and styles to your terminal.\n\n## How to use\nFirst go to the terminal and run `pip install ColorsAndStyles`. Then create a Python file and paste this code in it:\n\n```python\nfrom ColorsAndStyles import Color, Style, clear, RESET_ALL\n```\n\n`RESET_ALL` is a string with the ANSI escape code to reset all colors and styles.\n\n`clear` is a function that... Clears and flushes the terminal.\n\n### Color\n`Color` has 3 classes: `RGB`, `Foreground`, and `Background`.\n\nAs a string, an `RGB` value returns an ANSI color code.\n\n- `RGB` requires 4 arguments:\n\n| Parameter | Description |\n|----------------|-------------------------------------------------------------------------------------------------------------------|\n| `red` | The red value of the RGB. |\n| `green` | The green value of the RGB. |\n| `blue` | The blue value of the RGB. |\n| `isForeground` | Returns a foreground ANSI color code as a string if `True`. Else returns a background ANSI color code. (Optional) |\n\n- `Foreground` has 8 class variables: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, and `RESET`. They are assigned to their respective ANSI color codes. To use these color codes, simply concatenate them with a string like so:\n\n```python\nprint(f\"{Color.Foreground.RED}This text is red.{Color.Foreground.RESET}\")\n```\n\n- `Background` has 9 class variables: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE` and `RESET`. To use them, just concatenate them to a string just like `Foreground`'s class variables:\n\n```python\nprint(f\"{Color.Background.GREEN}This text is green.{Color.Background.RESET}\")\n```\n\n### Style\n`Style` has 6 class variables: `BOLD`, `DIM`, `ITALICS`, `UNDERLINE`, `STRIKETHROUGH`, and `RESET`. Like the classes in `Color`, they are assigned to their respective ANSI escape codes. Concatenate them to strings to use them:\n\n```python\nprint(f\"{Style.BOLD}This text is bold.{Style.RESET}\")\n```\n\n\n# Change Log\n\n## 0.0.5 (4/8/2023)\n\n- Added documentation for the `clear` function in the README.\n\n## 0.0.4 (4/8/2023)\n\n- Added a `clear` function\n- Slightly changed the README\n\n## 0.0.3 (4/2/2023)\n\n- Moved all the code into one file\n\n## 0.0.2 (4/2/2023)\n\n- Slightly changed the README\n\n## 0.0.1 (4/2/2023)\n\n- First release\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A basic package that makes it easy to add color and styles to your terminal.",
"version": "0.0.5",
"split_keywords": [
"color",
"style",
"ansi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4a2e0174aa075a6aed23e79babc5ab822ae2da264fe7f9ba9e64a3ae342609e",
"md5": "5eeac9ad2bd20e8a96b40c1fa14befa5",
"sha256": "a52f05838bff3646c253971a1b23af58c63725d8c194b04238dd804adb30d014"
},
"downloads": -1,
"filename": "ColorsAndStyles-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5eeac9ad2bd20e8a96b40c1fa14befa5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10843563,
"upload_time": "2023-04-08T07:44:43",
"upload_time_iso_8601": "2023-04-08T07:44:43.163882Z",
"url": "https://files.pythonhosted.org/packages/f4/a2/e0174aa075a6aed23e79babc5ab822ae2da264fe7f9ba9e64a3ae342609e/ColorsAndStyles-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-08 07:44:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "colorsandstyles"
}
