color-analysis-tool 1.0.0__tar.gz

color_analysis_tool-1.0.0/.gitignore

@@ -0,0 +1,182 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# PyPI configuration file
+.pypirc
+
+# Project-specific
+output/
+new/
+*.jpg
+*.jpeg
+*.png
+*.tiff
+*.webp
+*.psd
+!test_images/

color_analysis_tool-1.0.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-01-01
+
+### Added
+- Initial stable release
+- Comprehensive color analysis for images
+- Multiple color space support (RGB, HEX, CMYK)
+- Color harmony calculations:
+  - Complementary colors (180° hue offset)
+  - Analogous colors (±30° hue offset)
+  - Triadic colors (120° hue spacing)
+  - Tetradic colors (90° hue spacing)
+- Multiple sorting options for colors:
+  - By frequency (default)
+  - By hue
+  - By saturation
+  - By brightness
+- Dominant color detection
+- Batch processing with recursive directory scanning
+- Support for multiple image formats:
+  - PNG
+  - JPG/JPEG
+  - TIFF
+  - WebP
+  - PSD
+- Command-line interface (`color-analysis` command)
+- Python API for library usage
+- Progress bars for batch processing
+- Detailed text reports with full color information
+- MIT License
+- CITATION.cff for academic citations
+- Zenodo integration for DOI minting
+
+### Technical Details
+- Built with Python 3.7+ compatibility
+- Uses Pillow for image processing
+- Uses colormath for color space conversions
+- Uses tqdm for progress visualization
+- PEP 621 compliant packaging with pyproject.toml
+- Type hints throughout the codebase
+
+[Unreleased]: https://github.com/MichailSemoglou/color-analysis-tool/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/MichailSemoglou/color-analysis-tool/releases/tag/v1.0.0

color_analysis_tool-1.0.0/CITATION.cff

@@ -0,0 +1,39 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Color Analysis Tool
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Michail
+    family-names: Semoglou
+    orcid: 'https://orcid.org/0009-0003-3268-5657'
+repository-code: 'https://github.com/MichailSemoglou/color-analysis-tool'
+url: 'https://github.com/MichailSemoglou/color-analysis-tool'
+abstract: >-
+  A comprehensive Python tool for analyzing colors in images,
+  providing detailed information about color distributions,
+  harmonies, and various color space conversions (RGB, HEX, CMYK).
+  Features include single image and batch processing, dominant
+  color detection, color harmony calculations (complementary,
+  analogous, triadic, tetradic), and support for multiple image
+  formats.
+keywords:
+  - color analysis
+  - image processing
+  - color harmony
+  - design tools
+  - Python
+  - color extraction
+  - RGB
+  - CMYK
+  - HEX
+  - color space conversion
+  - batch processing
+  - dominant color detection
+license: MIT
+version: 1.0.0
+date-released: '2025-01-01'

color_analysis_tool-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michail Semoglou
+
+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.

color_analysis_tool-1.0.0/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.4
+Name: color-analysis-tool
+Version: 1.0.0
+Summary: A comprehensive tool for analyzing colors in images with harmony calculations and multiple color space conversions
+Project-URL: Homepage, https://github.com/MichailSemoglou/color-analysis-tool
+Project-URL: Repository, https://github.com/MichailSemoglou/color-analysis-tool
+Project-URL: Documentation, https://github.com/MichailSemoglou/color-analysis-tool#readme
+Project-URL: Issues, https://github.com/MichailSemoglou/color-analysis-tool/issues
+Project-URL: Changelog, https://github.com/MichailSemoglou/color-analysis-tool/blob/main/CHANGELOG.md
+Author: Michail Semoglou
+Maintainer: Michail Semoglou
+License-Expression: MIT
+License-File: LICENSE
+Keywords: CMYK,HEX,RGB,batch processing,color,color analysis,color extraction,color harmony,color space,design tools,dominant color,image processing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Artistic Software
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Python: >=3.7
+Requires-Dist: colormath>=3.0.0
+Requires-Dist: pillow>=9.0.0
+Requires-Dist: tqdm>=4.65.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: build>=0.10.0; extra == 'dev'
+Requires-Dist: flake8>=6.0.0; extra == 'dev'
+Requires-Dist: isort>=5.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: twine>=4.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Image Color Analysis Tool
+
+[![DOI](https://zenodo.org/badge/DOI/YOUR_DOI_HERE.svg)](https://doi.org/YOUR_DOI_HERE)
+[![PyPI version](https://badge.fury.io/py/color-analysis-tool.svg)](https://badge.fury.io/py/color-analysis-tool)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
+
+A powerful Python tool for analyzing colors in images, providing detailed information about color distributions, harmonies, and various color space conversions. Perfect for designers, artists, and developers working with color analysis and manipulation.
+
+## Features
+
+- **Comprehensive Color Analysis**: Extract and analyze colors from images
+- **Multiple Color Spaces**: Support for RGB, HEX, and CMYK color formats
+- **Color Harmony**: Calculate complementary, analogous, triadic, and tetradic color harmonies
+- **Color Sorting Options**: Sort colors by frequency, hue, saturation, or brightness
+- **Dominant Color Detection**: Automatically identify the most prominent color
+- **Batch Processing**: Analyze multiple images recursively in directories
+- **Detailed Reports**: Generate comprehensive analysis reports for each image
+- **Format Support**: Works with PNG, JPG, TIFF, WebP, and PSD files
+- **Progress Tracking**: Visual progress bars for processing status
+- **CLI and API**: Use as a command-line tool or import as a Python library
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install color-analysis-tool
+```
+
+### From Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/MichailSemoglou/color-analysis-tool.git
+cd color-analysis-tool
+```
+
+2. Create and activate a virtual environment (recommended):
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows, use: venv\Scripts\activate
+```
+
+3. Install the package:
+```bash
+# For regular use
+pip install .
+
+# For development (editable install with dev dependencies)
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Command Line Interface
+
+After installation, you can use the `color-analysis` command:
+
+```bash
+# Analyze a single image
+color-analysis path/to/image.jpg output/directory
+
+# Process all images in a directory
+color-analysis path/to/image/directory output/directory
+
+# Enable verbose logging
+color-analysis path/to/image.jpg output/directory -v
+
+# Sort colors by different criteria
+color-analysis path/to/image.jpg output/directory -s hue
+color-analysis path/to/image.jpg output/directory -s saturation
+color-analysis path/to/image.jpg output/directory -s brightness
+
+# Show version
+color-analysis --version
+```
+
+### Python API
+
+You can also use the tool as a library in your Python projects:
+
+```python
+from color_analysis_tool import ImageAnalyzer
+
+analyzer = ImageAnalyzer()
+
+# Analyze a single image with custom sorting
+image_info = analyzer.analyze_image('path/to/image.jpg', sort_by='hue')
+
+# Save the analysis
+analyzer.save_analysis('output/directory', image_info)
+
+# Process multiple images recursively
+analyzer.batch_process('input/directory', 'output/directory', sort_by='frequency')
+```
+
+#### Working with Analysis Results
+
+```python
+from color_analysis_tool import ImageAnalyzer, ColorConverter, ColorHarmony
+
+analyzer = ImageAnalyzer()
+image_info = analyzer.analyze_image('photo.jpg')
+
+# Access image metadata
+print(f"Image: {image_info.filename}")
+print(f"Dimensions: {image_info.dimensions}")
+print(f"Dominant color: {image_info.dominant_color}")
+
+# Iterate through colors
+for color in image_info.colors[:10]:  # Top 10 colors
+    print(f"RGB: {color.rgb}, HEX: {color.hex}, Frequency: {color.frequency}%")
+    print(f"  Complementary: {color.harmonies['complementary']}")
+
+# Use utility classes directly
+converter = ColorConverter()
+cmyk = converter.rgb_to_cmyk(255, 128, 64)
+
+harmony = ColorHarmony()
+harmonies = harmony.find_harmonies((255, 128, 64))
+```
+
+### Example Output
+
+The tool generates a detailed analysis file for each image with the following information:
+- Image metadata (dimensions, format)
+- Dominant color information
+- Color frequency analysis with sorting options
+- RGB, HEX, and CMYK values for each significant color
+- Color harmonies for each major color
+
+Example output structure:
+```
+Image Analysis for example.jpg
+Dimensions: 1920x1080
+Format: JPEG
+Dominant Color: RGB(255, 255, 255)
+
+Colors (sorted by frequency):
+  RGB: (255, 255, 255), HEX: #FFFFFF, CMYK: (0, 0, 0, 0), Frequency: 35.2%
+    Harmonies:
+      Complementary: [(0, 0, 0)]
+      Analogous: [(255, 245, 245), (255, 255, 255), (245, 255, 255)]
+      Triadic: [(255, 255, 0), (255, 255, 255), (0, 255, 255)]
+```
+
+## Requirements
+
+- Python 3.7 or higher
+- Pillow >= 9.0.0
+- tqdm >= 4.65.0
+- colormath >= 3.0.0
+
+## Citation
+
+If you use this software in your research, please cite it using the metadata in [CITATION.cff](CITATION.cff):
+
+```bibtex
+@software{semoglou_color_analysis_tool,
+  author       = {Semoglou, Michail},
+  title        = {Color Analysis Tool},
+  version      = {1.0.0},
+  year         = {2025},
+  url          = {https://github.com/MichailSemoglou/color-analysis-tool},
+  doi          = {YOUR_DOI_HERE}
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+### Development Setup
+
+1. Clone your fork:
+```bash
+git clone https://github.com/YOUR_USERNAME/color-analysis-tool.git
+cd color-analysis-tool
+```
+
+2. Set up development environment:
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+3. Run tests:
+```bash
+pytest
+```
+
+4. Format code:
+```bash
+black color_analysis_tool/
+isort color_analysis_tool/
+```
+
+5. Type checking:
+```bash
+mypy color_analysis_tool/
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- [Pillow](https://python-pillow.org/) for image processing capabilities
+- [colormath](https://python-colormath.readthedocs.io/) for color space conversions
+- [tqdm](https://github.com/tqdm/tqdm) for progress bar functionality
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this project.