colorbrew 0.1.0__tar.gz

colorbrew-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync
+      - run: uv run ruff check src/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync
+      - run: uv run pytest

colorbrew-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["[0-9]+.[0-9]+.[0-9]+"]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

colorbrew-0.1.0/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

colorbrew-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dawid Prus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

colorbrew-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: colorbrew
+Version: 0.1.0
+Summary: A lightweight, zero-dependency Python library for color manipulation.
+Project-URL: Homepage, https://github.com/zfoq/colorbrew
+Project-URL: Repository, https://github.com/zfoq/colorbrew
+Author: Dawid Prus
+License-Expression: MIT
+License-File: LICENSE
+Keywords: accessibility,color,css,hex,hsl,palette,rgb,wcag
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# ColorBrew
+
+A lightweight, zero-dependency Python library for working with colors.
+
+## Features
+
+- Parse colors from hex strings (`#3498db`, `#fff`, `3498db`)
+- Parse CSS function strings (`rgb(52, 152, 219)`, `hsl(204, 70%, 53%)`)
+- Parse CSS named colors (`cornflowerblue`, `red`, etc.)
+- Convert between hex, RGB, HSL, and CMYK formats
+- Input validation with clear error messages
+- 148 built-in CSS named colors
+- Immutable `Color` class with format properties and dunder methods
+- CSS/HTML-ready output (`rgb()`, `rgba()`, `hsl()`, `hsla()`, hex)
+- Format string support (`f"{color:rgb}"`, `f"{color:hsl}"`)
+- Reverse name lookup — find the closest CSS named color with distance score
+- Color manipulation — lighten, darken, saturate, desaturate, rotate hue, invert, grayscale, mix
+
+## Installation
+
+```bash
+pip install colorbrew
+```
+
+Requires Python 3.12+. Zero runtime dependencies.
+
+## Quick Start
+
+```python
+from colorbrew import Color
+
+# Create from any format
+c = Color("#3498db")
+c = Color(52, 152, 219)
+c = Color("rgb(52, 152, 219)")
+c = Color("cornflowerblue")
+
+# Alternate constructors
+c = Color.from_hsl(204, 70, 53)
+c = Color.from_cmyk(76, 31, 0, 14)
+c = Color.from_name("cornflowerblue")
+
+# Access format properties
+c.rgb                       # (52, 152, 219)
+c.hex                       # "#3498db"
+c.hsl                       # (204, 70, 53)
+c.cmyk                      # (76, 31, 0, 14)
+
+# CSS output
+c.css_rgb                   # "rgb(52, 152, 219)"
+c.css_hsl                   # "hsl(204, 70%, 53%)"
+c.css_hex                   # "#3498db"
+c.css_rgba(0.5)             # "rgba(52, 152, 219, 0.5)"
+c.css_hsla(0.8)             # "hsla(204, 70%, 53%, 0.8)"
+
+# Format strings
+f"{c:rgb}"                  # "rgb(52, 152, 219)"
+f"{c:hsl}"                  # "hsl(204, 70%, 53%)"
+f"{c:hex}"                  # "#3498db"
+
+# Reverse name lookup
+match = c.closest_name
+match.name                  # "steelblue"
+match.distance              # 10.7703
+match.exact                 # False
+
+# Manipulation (all return new Color instances)
+c.lighten(20)               # lighter color
+c.darken(10)                # darker color
+c.saturate(15)              # more vivid
+c.desaturate(15)            # more muted
+c.rotate(180)               # shift hue
+c.invert()                  # RGB inverse
+c.grayscale()               # remove saturation
+c.mix(Color("red"), 0.5)    # blend two colors
+
+# Iteration and comparison
+r, g, b = c                 # unpack RGB
+Color("#ff0000") == Color("red")  # True
+```
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check src/
+```
+
+## License
+
+MIT

colorbrew-0.1.0/README.md

@@ -0,0 +1,92 @@
+# ColorBrew
+
+A lightweight, zero-dependency Python library for working with colors.
+
+## Features
+
+- Parse colors from hex strings (`#3498db`, `#fff`, `3498db`)
+- Parse CSS function strings (`rgb(52, 152, 219)`, `hsl(204, 70%, 53%)`)
+- Parse CSS named colors (`cornflowerblue`, `red`, etc.)
+- Convert between hex, RGB, HSL, and CMYK formats
+- Input validation with clear error messages
+- 148 built-in CSS named colors
+- Immutable `Color` class with format properties and dunder methods
+- CSS/HTML-ready output (`rgb()`, `rgba()`, `hsl()`, `hsla()`, hex)
+- Format string support (`f"{color:rgb}"`, `f"{color:hsl}"`)
+- Reverse name lookup — find the closest CSS named color with distance score
+- Color manipulation — lighten, darken, saturate, desaturate, rotate hue, invert, grayscale, mix
+
+## Installation
+
+```bash
+pip install colorbrew
+```
+
+Requires Python 3.12+. Zero runtime dependencies.
+
+## Quick Start
+
+```python
+from colorbrew import Color
+
+# Create from any format
+c = Color("#3498db")
+c = Color(52, 152, 219)
+c = Color("rgb(52, 152, 219)")
+c = Color("cornflowerblue")
+
+# Alternate constructors
+c = Color.from_hsl(204, 70, 53)
+c = Color.from_cmyk(76, 31, 0, 14)
+c = Color.from_name("cornflowerblue")
+
+# Access format properties
+c.rgb                       # (52, 152, 219)
+c.hex                       # "#3498db"
+c.hsl                       # (204, 70, 53)
+c.cmyk                      # (76, 31, 0, 14)
+
+# CSS output
+c.css_rgb                   # "rgb(52, 152, 219)"
+c.css_hsl                   # "hsl(204, 70%, 53%)"
+c.css_hex                   # "#3498db"
+c.css_rgba(0.5)             # "rgba(52, 152, 219, 0.5)"
+c.css_hsla(0.8)             # "hsla(204, 70%, 53%, 0.8)"
+
+# Format strings
+f"{c:rgb}"                  # "rgb(52, 152, 219)"
+f"{c:hsl}"                  # "hsl(204, 70%, 53%)"
+f"{c:hex}"                  # "#3498db"
+
+# Reverse name lookup
+match = c.closest_name
+match.name                  # "steelblue"
+match.distance              # 10.7703
+match.exact                 # False
+
+# Manipulation (all return new Color instances)
+c.lighten(20)               # lighter color
+c.darken(10)                # darker color
+c.saturate(15)              # more vivid
+c.desaturate(15)            # more muted
+c.rotate(180)               # shift hue
+c.invert()                  # RGB inverse
+c.grayscale()               # remove saturation
+c.mix(Color("red"), 0.5)    # blend two colors
+
+# Iteration and comparison
+r, g, b = c                 # unpack RGB
+Color("#ff0000") == Color("red")  # True
+```
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check src/
+```
+
+## License
+
+MIT

colorbrew-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "colorbrew"
+version = "0.1.0"
+description = "A lightweight, zero-dependency Python library for color manipulation."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [{ name = "Dawid Prus" }]
+keywords = ["color", "hex", "rgb", "hsl", "css", "palette", "accessibility", "wcag"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/zfoq/colorbrew"
+Repository = "https://github.com/zfoq/colorbrew"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/colorbrew"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.9",
+]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+src = ["src"]
+
+[tool.ruff.lint]
+select = [
+    "E",     # pycodestyle errors
+    "W",     # pycodestyle warnings
+    "F",     # pyflakes
+    "I",     # isort
+    "UP",    # pyupgrade
+    "D",     # pydocstyle
+    "RUF",   # ruff-specific rules
+]
+ignore = []
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

colorbrew-0.1.0/src/colorbrew/__init__.py

@@ -0,0 +1,24 @@
+"""ColorBrew — a lightweight, zero-dependency Python library for colors.
+
+Provides color parsing, format conversion, CSS/HTML output, reverse name
+lookup, and color manipulation through a single ``Color`` class.
+"""
+
+from __future__ import annotations
+
+from colorbrew.color import Color
+from colorbrew.converters import hex_to_rgb, hsl_to_rgb, rgb_to_hex, rgb_to_hsl
+from colorbrew.exceptions import ColorBrewError, ColorParseError, ColorValueError
+from colorbrew.types import NameMatch
+
+__all__ = [
+    "Color",
+    "ColorBrewError",
+    "ColorParseError",
+    "ColorValueError",
+    "NameMatch",
+    "hex_to_rgb",
+    "hsl_to_rgb",
+    "rgb_to_hex",
+    "rgb_to_hsl",
+]