==========
Colour CxF
==========
A Python library for reading, manipulating, and writing Color Exchange Format (CxF) files.
About
=====
Colour CxF provides tools for working with CxF files, which are XML-based files used for exchanging color information between different applications and devices. The library allows you to:
- Read CxF files from strings or files
- Access and manipulate color data in various formats (RGB, CIELab, spectral)
- Create CxF objects programmatically
- Write CxF objects to XML strings
Installation
============
Primary Dependencies
~~~~~~~~~~~~~~~~~~~~
**Colour - CxF** requires some dependencies in order to run:
- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
- `typing-extensions >= 4, < 5 <https://pypi.org/project/typing-extensions>`__
Pypi
~~~~
Once the dependencies are satisfied, **Colour - CxF** can be installed from
the `Python Package Index <http://pypi.python.org/pypi/colour-cxf>`__ by
issuing this command in a shell::
pip install --user colour-cxf
The overall development dependencies are installed as follows::
pip install --user 'colour-cxf[development]'
UV
~~
Using uv you can simply install **Colour - CxF** via::
uv add colour-cxf
Quick Start
===========
.. code-block:: python
import colour_cxf
# Reading from a string
xml_string = """<?xml version="1.0" encoding="UTF-8"?>
<cc:CxF xmlns:cc="http://colorexchangeformat.com/CxF3-core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<cc:FileInformation>
<cc:Creator>Colour Developers</cc:Creator>
<cc:Description>Simple CxF Example</cc:Description>
</cc:FileInformation>
</cc:CxF>"""
# Parse the XML string
cxf = colour_cxf.read_cxf(xml_string.encode("utf-8"))
# Access file information
print(f"Creator: {cxf.file_information.creator}")
print(f"Description: {cxf.file_information.description}")
Documentation
=============
For more detailed information and examples, see the `tutorial <docs/tutorial.rst>`_.
License
=======
Colour CxF is licensed under the BSD-3-Clause license.
Raw data
{
"_id": null,
"home_page": null,
"name": "colour-cxf",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "Colour Developers <colour-developers@colour-science.org>",
"keywords": "CxF, color, color-science, color-space, color-spaces, colorspace, colorspaces, colour, colour-science, colour-space, colour-spaces, colourspace, colourspaces, python",
"author": null,
"author_email": "Colour Developers <colour-developers@colour-science.org>",
"download_url": "https://files.pythonhosted.org/packages/20/01/1e0f8cc1b13c91d5ce74b174b2c55c675b25388337d26fd8e5dc6edbeeae/colour_cxf-0.1.0.tar.gz",
"platform": null,
"description": "==========\nColour CxF\n==========\n\nA Python library for reading, manipulating, and writing Color Exchange Format (CxF) files.\n\nAbout\n=====\n\nColour CxF provides tools for working with CxF files, which are XML-based files used for exchanging color information between different applications and devices. The library allows you to:\n\n- Read CxF files from strings or files\n- Access and manipulate color data in various formats (RGB, CIELab, spectral)\n- Create CxF objects programmatically\n- Write CxF objects to XML strings\n\nInstallation\n============\n\nPrimary Dependencies\n~~~~~~~~~~~~~~~~~~~~\n\n**Colour - CxF** requires some dependencies in order to run:\n\n- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__\n- `typing-extensions >= 4, < 5 <https://pypi.org/project/typing-extensions>`__\n\nPypi\n~~~~\n\nOnce the dependencies are satisfied, **Colour - CxF** can be installed from\nthe `Python Package Index <http://pypi.python.org/pypi/colour-cxf>`__ by\nissuing this command in a shell::\n\n pip install --user colour-cxf\n\nThe overall development dependencies are installed as follows::\n\n pip install --user 'colour-cxf[development]'\n\nUV\n~~\n\nUsing uv you can simply install **Colour - CxF** via::\n\n uv add colour-cxf\n\nQuick Start\n===========\n\n.. code-block:: python\n\n import colour_cxf\n\n # Reading from a string\n xml_string = \"\"\"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <cc:CxF xmlns:cc=\"http://colorexchangeformat.com/CxF3-core\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n <cc:FileInformation>\n <cc:Creator>Colour Developers</cc:Creator>\n <cc:Description>Simple CxF Example</cc:Description>\n </cc:FileInformation>\n </cc:CxF>\"\"\"\n\n # Parse the XML string\n cxf = colour_cxf.read_cxf(xml_string.encode(\"utf-8\"))\n\n # Access file information\n print(f\"Creator: {cxf.file_information.creator}\")\n print(f\"Description: {cxf.file_information.description}\")\n\nDocumentation\n=============\n\nFor more detailed information and examples, see the `tutorial <docs/tutorial.rst>`_.\n\nLicense\n=======\n\nColour CxF is licensed under the BSD-3-Clause license.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Library to parse and create CxF files.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"cxf",
" color",
" color-science",
" color-space",
" color-spaces",
" colorspace",
" colorspaces",
" colour",
" colour-science",
" colour-space",
" colour-spaces",
" colourspace",
" colourspaces",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9e35a3261acd366db648a2d9e10d7faac621da946b0213a9978b6f41bf715e37",
"md5": "364409f379bf54a634ae507f88936fc8",
"sha256": "50bbe460c2f5d439f64bad116c7affeee1b78ae3ccf520ce42506cb679f3c5f9"
},
"downloads": -1,
"filename": "colour_cxf-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "364409f379bf54a634ae507f88936fc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 108593,
"upload_time": "2025-08-08T11:15:57",
"upload_time_iso_8601": "2025-08-08T11:15:57.192744Z",
"url": "https://files.pythonhosted.org/packages/9e/35/a3261acd366db648a2d9e10d7faac621da946b0213a9978b6f41bf715e37/colour_cxf-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "20011e0f8cc1b13c91d5ce74b174b2c55c675b25388337d26fd8e5dc6edbeeae",
"md5": "3fd7fd45c6191dabae94c609e0cc0dca",
"sha256": "a06a55bb6943de993e37d517f9d5715136f1c5a217f065cf8923c3dfc468291e"
},
"downloads": -1,
"filename": "colour_cxf-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3fd7fd45c6191dabae94c609e0cc0dca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 171926,
"upload_time": "2025-08-08T11:15:54",
"upload_time_iso_8601": "2025-08-08T11:15:54.781051Z",
"url": "https://files.pythonhosted.org/packages/20/01/1e0f8cc1b13c91d5ce74b174b2c55c675b25388337d26fd8e5dc6edbeeae/colour_cxf-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-08 11:15:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "colour-cxf"
}