Skip to content

Open-Imx:Icons

imxInsights logo imxInsights logo

Documentation: https://open-imx.github.io/imxIcons/

Source Code: https://github.com/open-imx/imxIcons

PyPi: https://pypi.org/project/imxIcons/

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

  • Get IMX icons by giving a object path and a set of properties.
  • Return icon name

Backlog and Roadmap

https://github.com/orgs/open-imx/projects/4/

Supported Python Versions

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

~~For more information on the design of the library, see contribution guidelines for this project.~~