# 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`.
[![PyPI version][pypi_badge]][pypi_link]
[](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`
## 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/alexeyev/gardiner2unicode",
"name": "gardiner2unicode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "egyptology, ancient egypt, fonts",
"author": "Anton Alekseev",
"author_email": "anton.m.alexeye@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/82/82210cda4d4d4ea7af7c295880cb2e2d6e1f865a55dc437d1b99b73ed3e0/gardiner2unicode-0.0.3.tar.gz",
"platform": null,
"description": "# gardiner2unicode: Mapping Egyptian Hieroglyphs\n\nA Python3.6+ package that \n* provides a convenient out-of-the-box way to access the mapping \nof [Gardiner's Sign List](https://en.wikipedia.org/wiki/Gardiner%27s_sign_list) codes to unicode IDs;\n* generates hieroglyphs as images.\n\nA list of hieroglyphs was copied from \n[this Wikipedia template](https://en.wikipedia.org/w/index.php?title=Template:List_of_hieroglyphs&action=edit).\n\nA 2.06 version of [NewGardiner font](https://mjn.host.cs.st-andrews.ac.uk/egyptian/fonts/newgardiner.html) is used\nby 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).\n\nOne can use any other font with `UnicodeGlyphGenerator`.\n\n\n\n[![PyPI version][pypi_badge]][pypi_link]\n[](https://pepy.tech/project/gardiner2unicode)\n\n[pypi_badge]: https://badge.fury.io/py/gardiner2unicode.svg\n[pypi_link]: https://pypi.python.org/pypi/gardiner2unicode\n\n## Installation\n\n pip install -U gardiner2unicode\n\n## Usage example\n\n```python\nfrom gardiner2unicode import GardinerToUnicodeMap, UnicodeGlyphGenerator\n\ng2u = GardinerToUnicodeMap()\nprint(g2u.to_unicode_hex(\"A1\"))\n\nugg = UnicodeGlyphGenerator()\nugg.generate_image(\"\ud80c\ude53\", save_path_png=\"O3_image.png\")\n```\nOutput:\n\n`00013000`\n\n![O3](O3_image.png?raw=true \"Generated O3 image: a combination of a house, an oar, a tall loaf and a beer jug.\")\n\n## How to cite\n\nPlease cite this repository if you use this work in your research.\n\n```bibtex\n@misc{gardiner2unicode2021alekseev,\n title = {{alexeyev/gardiner2unicode: Mapping Egyptian Hieroglyphs}},\n author = {Anton Alekseev}, \n year = {2021},\n url = {https://github.com/alexeyev/gardiner2unicode},\n language = {english},\n publisher = {GitHub}, \n journal = {GitHub repository}, \n howpublished = {\\url{https://github.com/alexeyev/gardiner2unicode/}}, \n}\n```\n\n## Links\n\n* [NewGardiner font](https://mjn.host.cs.st-andrews.ac.uk/egyptian/fonts/newgardiner.html)\n* [Gardiner's Sign List](https://en.wikipedia.org/wiki/Gardiner%27s_sign_list)\n",
"bugtrack_url": null,
"license": null,
"summary": "Mapping Gardiner's codes to Unicode + generating corresponding images.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/alexeyev/gardiner2unicode"
},
"split_keywords": [
"egyptology",
" ancient egypt",
" fonts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "555fa423d4fa0af76382590ee1b33f14acee6eae5bf0c709e768a5eb5188493c",
"md5": "54def43dea7a0c1b6ae4c5c4514fd699",
"sha256": "5b9f7ee4593871b9c8e13cf1d826fba00894f0fe865c201b505dcb88938e96f5"
},
"downloads": -1,
"filename": "gardiner2unicode-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54def43dea7a0c1b6ae4c5c4514fd699",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 374564,
"upload_time": "2025-07-19T21:48:13",
"upload_time_iso_8601": "2025-07-19T21:48:13.324492Z",
"url": "https://files.pythonhosted.org/packages/55/5f/a423d4fa0af76382590ee1b33f14acee6eae5bf0c709e768a5eb5188493c/gardiner2unicode-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c8282210cda4d4d4ea7af7c295880cb2e2d6e1f865a55dc437d1b99b73ed3e0",
"md5": "4cea65fa43546dc9a56f8eb50620b797",
"sha256": "e1e6f9caabd783fa4ea5785b4f384fefbbe45421fed12b88da7a6ae4b51d4985"
},
"downloads": -1,
"filename": "gardiner2unicode-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "4cea65fa43546dc9a56f8eb50620b797",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 375678,
"upload_time": "2025-07-19T21:48:20",
"upload_time_iso_8601": "2025-07-19T21:48:20.605792Z",
"url": "https://files.pythonhosted.org/packages/8c/82/82210cda4d4d4ea7af7c295880cb2e2d6e1f865a55dc437d1b99b73ed3e0/gardiner2unicode-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-19 21:48:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alexeyev",
"github_project": "gardiner2unicode",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "wikitextparser",
"specs": [
[
">=",
"0.47.9"
]
]
},
{
"name": "pillow",
"specs": []
}
],
"lcname": "gardiner2unicode"
}
JSON
