rich-gradient 0.1.0__tar.gz

rich_gradient-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv
+docs/img/.DS_Store

rich_gradient-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12.3

rich_gradient-0.1.0/.readthedocs.yaml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+mkdocs:
+  configuration: mkdocs.yml

rich_gradient-0.1.0/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}

rich_gradient-0.1.0/.vscode/rich-gradient.code-workspace

@@ -0,0 +1,220 @@
+{
+	"folders": [
+		{
+			"path": ".."
+		}
+	],
+	"settings": {
+		"editor.semanticTokenColorCustomizations": {
+			"enabled": true,
+			"rules": {
+				"variable": {
+					"foreground": "#55AAFF"
+				},
+				"function": {
+					"foreground": "#99ff00"
+				},
+				"parameter": {
+					"foreground": "#00afFF"
+				},
+				"property": {
+					"foreground": "#FF0099"
+				},
+				"enumMember": {
+					"foreground": "#FFFF00"
+				},
+				"enum": {
+					"foreground": "#0099FF"
+				},
+				"keyword": {
+					"foreground": "#9900ff"
+				},
+				"operator": {
+					"foreground": "#00FF00"
+				},
+				"comment": {
+					"foreground": "#3f3e86"
+				},
+				"number": {
+					"foreground": "#FFFF00"
+				},
+				"regexp": {
+					"foreground": "#00FFFF"
+				},
+				"type": {
+					"foreground": "#afff00"
+				},
+				"namespace": {
+					"foreground": "#00FF99"
+				},
+				"interface": {
+					"foreground": "#0000FF"
+				},
+				"struct": {
+					"foreground": "#9999FF"
+				},
+				"class": {
+					"foreground": "#999FFF"
+				},
+				"functionVariable": {
+					"foreground": "#7f44b7"
+				},
+				"constant": {
+					"foreground": "#afff00"
+				},
+				"string": {
+					"foreground": "#e5da95"
+				}
+			}
+		},
+		"files.associations": {
+			"*.yaml": "home-assistant"
+		},
+		"sqltools.connections": [
+			{
+				"name": "supergene",
+				"driver": "sqlite",
+				"server": "localhost",
+				"database": "/Users/maxludden/dev/py/supergene/db/supergene.db",
+				"username": "",
+				"password": "",
+				"port": 0,
+				"multipleStatements": true,
+				"ssl": false,
+				"isGlobal": true
+			},
+			{
+				"previewLimit": 50,
+				"driver": "SQLite",
+				"name": "supergene.db",
+				"database": "/Users/maxludden/dev/py/supergene/supergene.db"
+			}
+		]
+	},
+	"editor.tokenColorCustomizations": {
+		"textMateRules": [
+			{
+				"scope": "string.quoted.double.json meta.structure.dictionary.json string.quoted.double.json jsonc.comments",
+				"settings": {
+					"foreground": "#ffffcc"
+				}
+			},
+			{
+				"scope": "meta.key.json",
+				"settings": {
+					"foreground": "#ccffcc"
+				}
+			},
+			{
+				"scope": "support.type.property-name.json.comments",
+				"settings": {
+					"foreground": "#ffffff"
+				}
+			},
+			{
+				"scope": "string.json.comments",
+				"settings": {
+					"foreground": "#6771f8"
+				}
+			},
+			{
+				"scope": "meta.structure.dictionary.jvalue.json.comments",
+				"settings": {
+					"foreground": "#636497"
+				}
+			},
+			{
+				"scope": "meta.structure.dictionary.json.comments",
+				"settings": {
+					"foreground": "#74f194"
+				}
+			},
+			{
+				"scope": "meta.structure.dictionary.json.comments",
+				"settings": {
+					"foreground": "#abc6c0"
+				}
+			},
+			{
+				"scope": "source.json.comments",
+				"settings": {
+					"foreground": "#abc6c0"
+				}
+			},
+			{
+				"scope": "punctuation.support.type.property-name.begin",
+				"settings": {
+					"foreground": "#9ebdff"
+				}
+			},
+			{
+				"scope": "punctuation.support.type.property-name.end",
+				"settings": {
+					"foreground": "#9ebdff"
+				}
+			},
+			{
+				"scope": "constant.language",
+				"settings": {
+					"foreground": "#afff00"
+				}
+			},
+			{
+				"name": "Fstring Varialbe",
+				"scope": "constant.character.format.placeholder.other.python",
+				"settings": {
+					"foreground": "#ff00ff"
+				}
+			},
+			{
+				"scope": "meta.structure.dictionary.json.comments",
+				"settings": {
+					"foreground": "#74f194"
+				}
+			},
+			{
+				"scope": "meta.structure.dictionary.value.json.comments",
+				"settings": {
+					"foreground": "#9d4edd"
+				}
+			},
+			{
+				"scope": "source.json.comments",
+				"settings": {
+					"foreground": "#abc6c0"
+				}
+			},
+			{
+				"scope": "punctuation.support.type.property-name.begin",
+				"settings": {
+					"foreground": "#9ebdff"
+				}
+			},
+			{
+				"scope": "punctuation.support.type.property-name.end",
+				"settings": {
+					"foreground": "#9ebdff"
+				}
+			},
+			{
+				"scope": "constant.language",
+				"settings": {
+					"foreground": "#afff00"
+				}
+			},
+			{
+				"name": "F-string Varialbe",
+				"scope": "constant.character.format.placeholder.other.python",
+				"settings": {
+					"foreground": "#ff00ff"
+				}
+			}
+		],
+	},
+	"workbench.colorCustomizations": {
+		"gitDecoration.modifiedResourceForeground": "#ff00ff",
+		"gitDecoration.deletedResourceForeground": "#ff0000",
+		"gitDecoration.untrackedResourceForeground": "#00ff00",
+		"sidebar.background": "#000000",
+	}
+}

rich_gradient-0.1.0/.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "search.useIgnoreFiles": false,
+    "files.exclude": {
+        "**/.git": false,
+        "**/.svn": false,
+        "**/CVS": false
+    },
+    "python.analysis.diagnosticSeverityOverrides": {
+        "reportUnusedImport": false
+    },
+    "python.testing.pytestArgs": [
+        "tests",
+        "--color=yes"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+
+}

rich_gradient-0.1.0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.3
+Name: rich-gradient
+Version: 0.1.0
+Summary: Add your description here
+Author-email: Max Ludden <dev@maxludden.com>
+Requires-Python: >=3.8
+Requires-Dist: mkdocs-material>=9.5.27
+Requires-Dist: mkdocs>=1.6.0
+Requires-Dist: mkdocstrings-python>=1.10.5
+Requires-Dist: mkdocstrings>=0.25.1
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: pydantic-extra-types>=2.8.2
+Requires-Dist: pydantic>=2.7.4
+Requires-Dist: rich>=13.7.1
+Description-Content-Type: text/markdown
+
+# [![rich-gradient](docs/img/rich-gradient.svg)](https://maxludden.github.io/rich-gradient/)
+
+
+[![Python](https://img.shields.io/badge/Python-3.9%2C%203.10%2C%203.11%2C%203.12-blue)](https://www.python.org/) [![Rye](https://img.shields.io/badge/Rye-1.0-green)](https://www.rye.org/) [![PyPI](https://img.shields.io/pypi/v/rich-gradient)](https://pypi.org/project/rich_gradient/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/rich-gradient)](https://pypi.org/project/rich-gradient/)
+
+![gradient example](docs/img/gradient.svg)
+
+This library is a wrapper of the great [rich](https://GitHub.com/textualize/rich) library that extends [rich.text.Text](https://github.com/Textualize/rich/blob/master/rich/text.py) to allow for the easy generation gradient text from the user inputed colors or randomly if not colors are presented.
+
+Borrowing from [pydantic-Looextra-types](https://GitHub.com/pydantic/pydantic-extra-types)' [Color](https://github.com/pydantic/pydantic-extra-types/blob/main/pydantic_extra_types/color.py) class, rich_gradient extends the rich standard colors to include:
+- 3 or 6 digit hex code (e.g. `#f00` or `#ff0000`)
+- RGB color codes (e.g. `rgb(255, 0, 0)`)
+- RGB tuples   (e.g. `(255, 0, 0)`)
+- CSS3 Color Names (e.g. `red`)
+
+---
+
+Read the docs at [rich-gradient.readthedocs.io](https://rich-gradient.readthedocs.io)
+
+## Installation
+
+### Rye (Recommended)
+```bash
+rye add rich-gradient
+```
+
+### Pip
+```bash
+pip install rich-gradient
+```
+
+## Usage
+
+### Basic Gradient Example
+
+To print a simple gradient just substitue the `Gradient` class for the `Text` class in the rich library.
+
+```python
+from rich.console import Console
+from rich_gradient import Gradient
+
+console = Console()
+console.print(Gradient("Hello, World!")
+```
+![Hello, World!](docs/img/hello_world.svg)
+
+---
+
+### Gradient with Specific Colors
+
+If you want a bit more control of the gradient, you can specify the colors you want to use in the gradient by passing them as a list of colors to the `colors` parameter.
+
+#### Color Formats
+
+Color can be parsed from a variety of formats including:
+
+![3 or 6 digit hex colors, rgb/rgba colors, and CSS3 Named Colors](docs/img/color_formats.svg)
+
+#### Example Code
+
+```python
+console.print(
+    Gradient(
+        "This a gradient with specific colors.",
+        colors=["red", "#ff9900", "#ff0", "Lime"],
+        justify="center"
+    )
+)
+```
+
+#### Specific Color Gradient Result:
+
+![specific colors](docs/img/specific_color_gradient.svg)
+
+--- 
+
+### Rainbow Gradient Example
+
+If four colors isn't enough, you can use the 'rainbow' parameter to generate a rainbow gradient that spans the entire spectrum of colors randomly.
+
+```python
+console.print(
+    Gradient(
+        "This is a rainbow gradient.",
+        rainbow=True,
+        justify="center"
+    )
+)
+```
+
+
+![Rainbow Gradient](docs/img/example_rainbow_gradient.svg)
+<p style="text-align:right;">*The rainbow gradient is generated randomly each time the code is run.</p>
+
+---
+
+### Still inherits from `rich.text.Text`
+
+Since `Gradient` is a subclass of `Text`, you can still use all the same methods and properties as you would with `Text`.
+
+```python
+console.print(
+    Gradient(
+        "This is an underlined rainbow gradient.",
+        rainbow=True,
+        style="underline"
+    ),
+    justify="center"
+)
+console.line()
+console.print(
+    Gradient(
+        "This is a bold italic gradient.",
+        style="bold italic"
+    ),
+    justify="center"
+)
+console.line()
+```
+
+![Still Text](docs/img/still_text.svg)
+

rich_gradient-0.1.0/README.md

@@ -0,0 +1,122 @@
+# [![rich-gradient](docs/img/rich-gradient.svg)](https://maxludden.github.io/rich-gradient/)
+
+
+[![Python](https://img.shields.io/badge/Python-3.9%2C%203.10%2C%203.11%2C%203.12-blue)](https://www.python.org/) [![Rye](https://img.shields.io/badge/Rye-1.0-green)](https://www.rye.org/) [![PyPI](https://img.shields.io/pypi/v/rich-gradient)](https://pypi.org/project/rich_gradient/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/rich-gradient)](https://pypi.org/project/rich-gradient/)
+
+![gradient example](docs/img/gradient.svg)
+
+This library is a wrapper of the great [rich](https://GitHub.com/textualize/rich) library that extends [rich.text.Text](https://github.com/Textualize/rich/blob/master/rich/text.py) to allow for the easy generation gradient text from the user inputed colors or randomly if not colors are presented.
+
+Borrowing from [pydantic-Looextra-types](https://GitHub.com/pydantic/pydantic-extra-types)' [Color](https://github.com/pydantic/pydantic-extra-types/blob/main/pydantic_extra_types/color.py) class, rich_gradient extends the rich standard colors to include:
+- 3 or 6 digit hex code (e.g. `#f00` or `#ff0000`)
+- RGB color codes (e.g. `rgb(255, 0, 0)`)
+- RGB tuples   (e.g. `(255, 0, 0)`)
+- CSS3 Color Names (e.g. `red`)
+
+---
+
+Read the docs at [rich-gradient.readthedocs.io](https://rich-gradient.readthedocs.io)
+
+## Installation
+
+### Rye (Recommended)
+```bash
+rye add rich-gradient
+```
+
+### Pip
+```bash
+pip install rich-gradient
+```
+
+## Usage
+
+### Basic Gradient Example
+
+To print a simple gradient just substitue the `Gradient` class for the `Text` class in the rich library.
+
+```python
+from rich.console import Console
+from rich_gradient import Gradient
+
+console = Console()
+console.print(Gradient("Hello, World!")
+```
+![Hello, World!](docs/img/hello_world.svg)
+
+---
+
+### Gradient with Specific Colors
+
+If you want a bit more control of the gradient, you can specify the colors you want to use in the gradient by passing them as a list of colors to the `colors` parameter.
+
+#### Color Formats
+
+Color can be parsed from a variety of formats including:
+
+![3 or 6 digit hex colors, rgb/rgba colors, and CSS3 Named Colors](docs/img/color_formats.svg)
+
+#### Example Code
+
+```python
+console.print(
+    Gradient(
+        "This a gradient with specific colors.",
+        colors=["red", "#ff9900", "#ff0", "Lime"],
+        justify="center"
+    )
+)
+```
+
+#### Specific Color Gradient Result:
+
+![specific colors](docs/img/specific_color_gradient.svg)
+
+--- 
+
+### Rainbow Gradient Example
+
+If four colors isn't enough, you can use the 'rainbow' parameter to generate a rainbow gradient that spans the entire spectrum of colors randomly.
+
+```python
+console.print(
+    Gradient(
+        "This is a rainbow gradient.",
+        rainbow=True,
+        justify="center"
+    )
+)
+```
+
+
+![Rainbow Gradient](docs/img/example_rainbow_gradient.svg)
+<p style="text-align:right;">*The rainbow gradient is generated randomly each time the code is run.</p>
+
+---
+
+### Still inherits from `rich.text.Text`
+
+Since `Gradient` is a subclass of `Text`, you can still use all the same methods and properties as you would with `Text`.
+
+```python
+console.print(
+    Gradient(
+        "This is an underlined rainbow gradient.",
+        rainbow=True,
+        style="underline"
+    ),
+    justify="center"
+)
+console.line()
+console.print(
+    Gradient(
+        "This is a bold italic gradient.",
+        style="bold italic"
+    ),
+    justify="center"
+)
+console.line()
+```
+
+![Still Text](docs/img/still_text.svg)
+

rich_gradient-0.1.0/cspell.json

@@ -0,0 +1,9 @@
+{
+    "version": "0.2",
+    "ignorePaths": [],
+    "dictionaryDefinitions": [],
+    "dictionaries": ["Max's Dictionary"],
+    "words": [],
+    "ignoreWords": [],
+    "import": []
+}

rich_gradient-0.1.0/docs/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v0.0.1 - 2021-10-10
+
+Initial release. Based off of MaxGradient with a simplified color model based on pydantic-extra-types.color.Color. Re-released as rich-gradient to avoid confusion with MaxGradient.

rich_gradient-0.1.0/docs/color.md

@@ -0,0 +1,11 @@
+# Color
+
+`rich-gradient`'s Color class is a subclass of `pydantic_extra_types.color.Color` that extends the rich standard colors to include:
+
+- 3 digit hex codes (e.g. `#f00`)
+- 6 digit hex codes (e.g. `#ff0000`)
+- RGB color codes (e.g. `rgb(255, 0, 0)`)
+- RGB tuples (e.g. `(255, 0, 0)`)
+- CSS3 Color Names (e.g. `red`)
+
+![colors](img/colors.svg)

rich_gradient-0.1.0/docs/color_ref.md

@@ -0,0 +1,13 @@
+# Color
+
+::: rich_gradient.color.Color
+    :docstring:
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+    :special-members: __init__
+    :exclude-members: __weakref__
+    :inherited-members:
+    :exclude-members: __weakref__
+    :noindex:

rich_gradient-0.1.0/docs/gradient.md

@@ -0,0 +1,36 @@
+# Gradient
+
+The `Gradient` class is a subclass of `Text` that allows you to create gradients of color in your text. You can just enter text and allow rich-gradient to generate a random gradient of color for you text,specify the colors you want to use, or generate a random rainbow gradient.
+
+## Random Gradient
+    
+```python
+    from rich import Console
+    from rich_gradient import Gradient
+
+    console = Console()
+    console.print(
+        Gradient(
+            "The quick brown fox jumps over the lazy dog."
+        )
+    )
+```
+
+![Random Gradient](img/random_gradient_example.svg)
+
+## Specific Color Gradient
+
+
+You can specify the colors you want to use in your gradient by passing a list of color names, hex color codes, rgb color codes, or [`rich_gradient.color.Color`](color.md)  to the `colors` parameter.
+
+```python
+    console.print(
+        Gradient(
+            "This a gradient with specific colors.",
+            colors=["red", "#ff9900", "#ff0", "Lime"],
+            justify="center"
+        )
+    )
+```
+
+![specific color gradient](img/specific_color_gradient.svg)

rich_gradient-0.1.0/docs/gradient_ref.md

@@ -0,0 +1,13 @@
+# Gradient
+
+::: rich_gradient.gradient.Gradient
+    :docstring:
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+    :special-members: __init__
+    :exclude-members: __weakref__
+    :inherited-members:
+    :exclude-members: __weakref__
+    :noindex: