| Name | colorxs JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Make your terminal output a little more colorful. |
| upload_time | 2024-10-19 15:07:03 |
| maintainer | None |
| docs_url | None |
| author | Ethan Illingsworth |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ColorXs
Make your terminal output a little more colorful.
## Table of Contents
* [Install](#install)
* [Quick Start](#quick-start)
* [Docs](#docs)
* [Contributing](#contributing)
## Install
To install ColorXs use `pip`.
```
pip3 install colorxs
```
## Quick Start
To get started with ColorXs first import functions from `colorxs` into your project like this.
```py
from colorxs import FUNCTIONS_HERE
```
To find out what to import, and how to use ColorXs check out the [docs](#docs).
## Docs
### Color
A Color made from an RGBValue.
Usage:
```py
from colorxs import Color, RGBValue, HexValue
# Make from RGBValue
color = Color(RGBValue(255, 255, 255))
# Make from HexValue
color = Color(HexValue("#ffffff").toRGB())
# Make from preset
color = Color.WHITE
# print with color
# Color.RESET sets color back to normal
print(f"{color}Hello World{Color.RESET}")
# Hello World (in white)
```
### RGBValue
Used to store basic RGB data.
Usage:
```py
from colorxs import RGBValue
rgb = RGBValue(255, 255, 255)
hexFromRGB = rgb.toHex()
print(rgb)
# RGBValue(255, 255, 255)
print(hexFromRGB)
# #ffffff
```
### HexValue
Used to store basic Hex data.
Usage:
```py
from colorxs import HexValue
h = HexValue("#FFFFFF")
rgbFromHex = h.toRGB()
print(h)
# #ffffff
print(rgbFromHex)
# RGBValue(255, 255, 255)
```
## Contributing
All types of contibutions are welcome for the ColorXs project, whether its updating the documentation, reporting issues, or simply mentioning TSafe in your projects.
Remember this before contibuting, you should open an **Issue** if you don't think you can contribute and open a **Pull Request** if you have a patch for an issue.
### Reporting Bugs
Before you submit a bug report make sure you have the following information or are using the following things.
* Make sure you're on the latest version.
* Make sure its not just on your end (if you were possibly using a python version we dont support).
* Check issues to see if it has already been reported.
* Collect the following info about the bug:
* Stack Trace.
* OS, Platform and Version (Windows, Linux, macOS, x86, ARM).
* Possibly your input and the output.
* Can you reliably reproduce the issue?
If you have all of that prepared you are more than welcome to open an issue for the community to take a look at.
Raw data
{
"_id": null,
"home_page": null,
"name": "colorxs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Ethan Illingsworth",
"author_email": "illingsworth.ethan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/aa/8f/fbe229272b554e6b2611e50097a90fecf70f1a12010f237845ea1c646c6a/colorxs-1.0.1.tar.gz",
"platform": null,
"description": "# ColorXs\nMake your terminal output a little more colorful.\n\n\n\n\n\n## Table of Contents\n* [Install](#install)\n* [Quick Start](#quick-start)\n* [Docs](#docs)\n* [Contributing](#contributing)\n\n## Install\nTo install ColorXs use `pip`.\n```\npip3 install colorxs\n```\n\n## Quick Start\nTo get started with ColorXs first import functions from `colorxs` into your project like this.\n```py\nfrom colorxs import FUNCTIONS_HERE\n```\n\nTo find out what to import, and how to use ColorXs check out the [docs](#docs).\n\n\n## Docs\n\n### Color\nA Color made from an RGBValue.\n\nUsage:\n```py\nfrom colorxs import Color, RGBValue, HexValue\n\n# Make from RGBValue\ncolor = Color(RGBValue(255, 255, 255))\n\n# Make from HexValue\ncolor = Color(HexValue(\"#ffffff\").toRGB())\n\n# Make from preset\ncolor = Color.WHITE\n\n# print with color\n# Color.RESET sets color back to normal\nprint(f\"{color}Hello World{Color.RESET}\")\n# Hello World (in white)\n```\n\n### RGBValue\nUsed to store basic RGB data.\n\nUsage:\n```py\nfrom colorxs import RGBValue\n\nrgb = RGBValue(255, 255, 255)\nhexFromRGB = rgb.toHex()\n\nprint(rgb)\n# RGBValue(255, 255, 255)\nprint(hexFromRGB)\n# #ffffff\n```\n\n### HexValue\nUsed to store basic Hex data.\n\nUsage:\n```py\nfrom colorxs import HexValue\n\nh = HexValue(\"#FFFFFF\")\nrgbFromHex = h.toRGB()\n\nprint(h)\n# #ffffff\nprint(rgbFromHex)\n# RGBValue(255, 255, 255)\n```\n\n## Contributing\nAll types of contibutions are welcome for the ColorXs project, whether its updating the documentation, reporting issues, or simply mentioning TSafe in your projects.\n\nRemember this before contibuting, you should open an **Issue** if you don't think you can contribute and open a **Pull Request** if you have a patch for an issue.\n\n\n\n### Reporting Bugs\nBefore you submit a bug report make sure you have the following information or are using the following things.\n\n* Make sure you're on the latest version.\n* Make sure its not just on your end (if you were possibly using a python version we dont support).\n* Check issues to see if it has already been reported.\n* Collect the following info about the bug:\n * Stack Trace.\n * OS, Platform and Version (Windows, Linux, macOS, x86, ARM).\n * Possibly your input and the output.\n * Can you reliably reproduce the issue?\n\nIf you have all of that prepared you are more than welcome to open an issue for the community to take a look at.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Make your terminal output a little more colorful.",
"version": "1.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "84b2153d33b0af0ce9502abb7805003afa134b5974c52eb6bc05dd0980aa1b88",
"md5": "0da5b1303351a1b0d8fb4261e3694fe4",
"sha256": "15ddef89082355cebcd628777f0b721931c4077ade70fba357cedcc4cc4be085"
},
"downloads": -1,
"filename": "colorxs-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0da5b1303351a1b0d8fb4261e3694fe4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 2842,
"upload_time": "2024-10-19T15:07:01",
"upload_time_iso_8601": "2024-10-19T15:07:01.624028Z",
"url": "https://files.pythonhosted.org/packages/84/b2/153d33b0af0ce9502abb7805003afa134b5974c52eb6bc05dd0980aa1b88/colorxs-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa8ffbe229272b554e6b2611e50097a90fecf70f1a12010f237845ea1c646c6a",
"md5": "f8de911928d467c9449fd8dd12c69f32",
"sha256": "6a1ea36d2b20269d4a96a626ddbf72b11159fc5e33f1132937e53d7bf890fed3"
},
"downloads": -1,
"filename": "colorxs-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f8de911928d467c9449fd8dd12c69f32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 2475,
"upload_time": "2024-10-19T15:07:03",
"upload_time_iso_8601": "2024-10-19T15:07:03.203297Z",
"url": "https://files.pythonhosted.org/packages/aa/8f/fbe229272b554e6b2611e50097a90fecf70f1a12010f237845ea1c646c6a/colorxs-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 15:07:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "colorxs"
}
