Metadata-Version: 2.3
Name: imxIcons
Version: 0.0.1.dev2
Summary: python imx insights module to get information from imx files
Project-URL: Documentation, https://open-imx.github.io/imxIcons/
Project-URL: Source, https://github.com/open-imx/ImxIcons
Author-email: Hzd <Hazedd@users.noreply.github.com>, Open-Imx <open-imx@organisation.noreply.github.com>
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: lxml
Requires-Dist: pydantic
Requires-Dist: types-lxml
Description-Content-Type: text/markdown

# imxIcons

![imxInsights logo](https://raw.githubusercontent.com/open-imx/imxIcons/main/docs/assets/logo.svg#only-dark#gh-dark-mode-only)
![imxInsights logo](https://raw.githubusercontent.com/open-imx/imxIcons/main/docs/assets/logo-light.svg#only-light#gh-light-mode-only)


**Documentation**: <a href="https://open-imx.github.io/imxInsights/" target="_blank">https://open-imx.github.io/imxIcons/</a>

**Source Code**: <a href="https://github.com/open-imx/imxInsights" target="_blank">https://github.com/open-imx/imxIcons</a>
**PyPi**: <a href="<https://pypi.org/project/imxIcons/" target="_blank"><https://pypi.org/project/imxIcons/</a> 

This is a personal project and therefore no responsibility for the functionality, accuracy, or usage of this library / api.

## Roadmap

###  Q4 2024
- [ ] test all specified icons for v125 and v500
- [ ] Add way of working docs.
- [ ] Just return the icon name (local icons storage).
- [ ] Setup github actions including trigger to redeploy api on change of service. 
  
### Backlog
- [ ] Icon mapping docs.
- [ ] Get all icons in zip.

## Supported Python Versions
This library is compatible with ***Python 3.10*** and above. 

!!! warning  
    ***Python Typehints are awesome therefor 3.9 and below will NOT be supported***.

## Features
- [X] Get IMX icons by giving a object path and a set of properties.
- [X] Qgis icons.

## Quick Start
todo

## Distribution and installation
todo

## Code samples and snippets
todo

## Contributing
Contributions welcome! For more information on the design of the library, see [contribution guidelines for this project](CONTRIBUTING.md).

