Metadata-Version: 2.1
Name: gardiner2unicode
Version: 0.0.2
Summary: Mapping Gardiner's codes to Unicode + generating corresponding images.
Home-page: https://github.com/alexeyev/gardiner2unicode
Author: Anton Alekseev
Author-email: anton.m.alexeye@gmail.com
License: UNKNOWN
Description: # gardiner2unicode: Mapping Egyptian Hieroglyphs
        
        A Python3.6+ package that 
        * provides a convenient out-of-the-box way to access the mapping 
        of [Gardiner's Sign List](https://en.wikipedia.org/wiki/Gardiner%27s_sign_list) codes to unicode IDs;
        * generates hieroglyphs as images.
        
        A list of hieroglyphs was copied from 
        [this Wikipedia template](https://en.wikipedia.org/w/index.php?title=Template:List_of_hieroglyphs&action=edit).
        
        A 2.06 version of [NewGardiner font](https://mjn.host.cs.st-andrews.ac.uk/egyptian/fonts/newgardiner.html) is used
        by default. Please note that since 2.05 its license is [OFL 1.1](https://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web).
        
        One can use any other font with `UnicodeGlyphGenerator`.
        
        
        ![Python 3x](https://img.shields.io/badge/python-3.x-blue.svg)
        [![PyPI version][pypi_badge]][pypi_link]
        [![Downloads](https://pepy.tech/badge/gardiner2unicode)](https://pepy.tech/project/gardiner2unicode)
        
        [pypi_badge]: https://badge.fury.io/py/gardiner2unicode.svg
        [pypi_link]: https://pypi.python.org/pypi/gardiner2unicode
        
        ## Installation
        
            pip install -U gardiner2unicode
        
        ## Usage example
        
        ```python
        from gardiner2unicode import GardinerToUnicodeMap, UnicodeGlyphGenerator
        
        g2u = GardinerToUnicodeMap()
        print(g2u.to_unicode_hex("A1"))
        
        ugg = UnicodeGlyphGenerator()
        ugg.generate_image("𓉓", save_path_png="O3_image.png")
        ```
        Output:
        
        `00013000`
        
        ![O3](O3_image.png?raw=true "Generated O3 image: a combination of a house, an oar, a tall loaf and a beer jug.")
        
        ## How to cite
        
        Please cite this repository if you use this work in your research.
        
        ```bibtex
        @misc{gardiner2unicode2021alekseev,
          title     = {{alexeyev/gardiner2unicode: Mapping Egyptian Hieroglyphs}},
          author    = {Anton Alekseev}, 
          year      = {2021},
          url       = {https://github.com/alexeyev/gardiner2unicode},
          language  = {english},
          publisher = {GitHub}, 
          journal   = {GitHub repository},  
          howpublished = {\url{https://github.com/alexeyev/gardiner2unicode/}}, 
        }
        ```
        
        ## Links
        
        * [NewGardiner font](https://mjn.host.cs.st-andrews.ac.uk/egyptian/fonts/newgardiner.html)
        * [Gardiner's Sign List](https://en.wikipedia.org/wiki/Gardiner%27s_sign_list)
Keywords: egyptology,ancient egypt,fonts
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
