Metadata-Version: 2.3
Name: imxIcons
Version: 0.0.2.dev1
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

# Open-Imx:Icons

![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/imxIcons/" target="_blank">https://open-imx.github.io/imxIcons/</a>

**Source Code**: <a href="https://github.com/open-imx/ImxIcons" 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>

**imxIcons** is a Python library that provides an intuitive and unified set of standardized icons representing IMX objects based on their properties. 
By transforming complex IMX data into clear visual representations, **imxIcons** enhances user experiences across applications in the railway sector. 
These icons help streamline the visualization of railway data across various tools and applications, improving the accessibility and user-friendliness of IMX data. 

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

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

## Roadmap
- [ ] Qgis icons.
- [ ] set up mkdocs proper
- [ ] test all specified icons for v125 and v500
- [ ] Add way of working docs.
- [ ] 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***.

## Quick Start
TODO

## Distribution and installation
Just install the library

```pip install imxIcons```

https://github.com/open-imx/imxIconsApi
for a demo see: https://imx-icons-api.azurewebsites.net/


## Code samples and snippets
TODO

## Contributing
Contributions welcome! [Join our Discord Community](https://discord.gg/wBses7bPFg) 

## 

~~For more information on the design of the library, see [contribution guidelines for this project](CONTRIBUTING.md).~~

