================================================================
Potnia
================================================================
.. image:: https://raw.githubusercontent.com/AncientNLP/potnia/main/docs/_static/img/PotniaLogo.png
.. start-summary
|pypi badge| |testing badge| |coverage badge| |docs badge| |git3moji badge| |black badge|
.. |pypi badge| image:: https://img.shields.io/pypi/v/potnia
:target: https://pypi.org/project/potnia/
.. |testing badge| image:: https://github.com/AncientNLP/potnia/actions/workflows/testing.yml/badge.svg
:target: https://github.com/AncientNLP/potnia/actions
.. |coverage badge| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/rbturnbull/e640f26fb59e39e3051de8fbf020de62/raw/coverage.json
:target: https://ancientnlp.github.io/potnia/coverage/
.. |docs badge| image:: https://github.com/AncientNLP/potnia/actions/workflows/docs.yml/badge.svg
:target: https://ancientnlp.github.io/potnia
.. |black badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |git3moji badge| image:: https://img.shields.io/badge/git3moji-%E2%9A%A1%EF%B8%8F%F0%9F%90%9B%F0%9F%93%BA%F0%9F%91%AE%F0%9F%94%A4-fffad8.svg
:target: https://robinpokorny.github.io/git3moji/
Potnia is an open-source Python library designed to convert Romanized transliterations of ancient texts into Unicode representations of ther respective native scripts.
Currently, the scripts supported by Potnia are:
- Linear A
- Linear B
- Hittite cuneiform
- Arabic
Functionality for Luwian hieroglyphs, Sumero-Akkadian cuneiform and Etruscan is in development.
Contributions are welcome! Please see the `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ file for more information.
.. end-summary
.. start-quickstart
Installation
====================
To install Potnia, run the following command:
.. code-block:: bash
pip install potnia
To install the latest version from the repository, you can use this command:
.. code-block:: bash
pip install git+https://github.com/AncientNLP/potnia.git
Usage
====================
To convert transliterated Linear B to Linear B Unicode, use the following code:
.. code-block:: python
>>> from potnia import linear_b
>>> linear_b("a-ri-to-jo")
'ππͺπ΅π'
If you wish to regularize the text to remove additional annotations present in the `LiBER <https://liber.cnr.it/index>`_
and `DΔMOS <https://damos.hf.uio.no/about/content/>`_ transliteration, use the following code:
.. code-block:: python
>>> linear_b("e-ke-qe ]-o-na-to , ke-ke-me-naβ βko-to-na GRA qs ] vac.", regularize=True)
'πππ€ %πππ΅ ππππ ππ΅π π %'
Note that uncertain/missing signs or sections of text are presently being replaced with a wildcard '%' character.
To tokenize transliterated Linear B texts without converting it to Unicode, use the following code:
.. code-block:: python
>>> linear_b.tokenize_transliteration("]wa VIR 1 MUL 2 'ko-wa 1' ko-wo 1")
[']', 'wa', ' ', 'VIR', ' ', '1', ' ', 'MUL', ' ', '2', ' ', "'", 'ko', 'wa', ' ', '1', "'", ' ', 'ko', 'wo', ' ', '1']
Command Line Interface (CLI)
============================
Potnia also provides a command line interface (CLI).
To convert transliterated Linear B to Unicode, use the following command:
.. code-block:: bash
potnia linear-b "a-ri-to-jo"
To regularize the text, use the following command:
.. code-block:: bash
potnia linear-b "e-ke-qe ]-o-na-to , ke-ke-me-naβ βko-to-na GRA qs ] vac." --regularize
To see the full set of commands available in the CLI, use the following command:
.. code-block:: bash
potnia --help
Graphical User Interface (GUI)
==============================
.. image:: https://raw.githubusercontent.com/AncientNLP/potnia/main/docs/_static/img/potnia-gui.png
Potnia also provides a graphical user interface (GUI). To start it, run:
.. code-block:: bash
potnia gui
This will show a link in the terminal that you can click on to open the GUI in your browser.
.. end-quickstart
Credits
====================
.. start-credits
Potnia is developed by:
- Emily Tour (University of Melbourne)
- `Kabir Manandhar Shrestha <https://findanexpert.unimelb.edu.au/profile/892683-kabir-manandhar-shrestha>`_ (Melbourne Data Analytics Platform, University of Melbourne)
- `Dr Robert Turnbull <https://findanexpert.unimelb.edu.au/profile/877006-robert-turnbull>`_ (Melbourne Data Analytics Platform, University of Melbourne)
.. end-credits
Raw data
{
"_id": null,
"home_page": "https://github.com/AncientNLP/potnia/",
"name": "potnia",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "linear a, linear b, sumerian, akkadian, cuneiform, unicode",
"author": "Emily Tour",
"author_email": "esmtour@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e3/20/5d467e05d5af2c24237b9e710c6fa2344a7f96731475ef3e3ad66a51a110/potnia-0.3.2.tar.gz",
"platform": null,
"description": "================================================================\nPotnia\n================================================================\n\n.. image:: https://raw.githubusercontent.com/AncientNLP/potnia/main/docs/_static/img/PotniaLogo.png\n\n.. start-summary\n\n|pypi badge| |testing badge| |coverage badge| |docs badge| |git3moji badge| |black badge|\n\n.. |pypi badge| image:: https://img.shields.io/pypi/v/potnia\n :target: https://pypi.org/project/potnia/\n\n.. |testing badge| image:: https://github.com/AncientNLP/potnia/actions/workflows/testing.yml/badge.svg\n :target: https://github.com/AncientNLP/potnia/actions\n \n.. |coverage badge| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/rbturnbull/e640f26fb59e39e3051de8fbf020de62/raw/coverage.json\n :target: https://ancientnlp.github.io/potnia/coverage/\n\n.. |docs badge| image:: https://github.com/AncientNLP/potnia/actions/workflows/docs.yml/badge.svg\n :target: https://ancientnlp.github.io/potnia\n \n.. |black badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |git3moji badge| image:: https://img.shields.io/badge/git3moji-%E2%9A%A1%EF%B8%8F%F0%9F%90%9B%F0%9F%93%BA%F0%9F%91%AE%F0%9F%94%A4-fffad8.svg\n :target: https://robinpokorny.github.io/git3moji/\n\n\n\nPotnia is an open-source Python library designed to convert Romanized transliterations of ancient texts into Unicode representations of ther respective native scripts.\n\nCurrently, the scripts supported by Potnia are:\n\n- Linear A\n- Linear B\n- Hittite cuneiform\n- Arabic\n\nFunctionality for Luwian hieroglyphs, Sumero-Akkadian cuneiform and Etruscan is in development.\n\nContributions are welcome! Please see the `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ file for more information.\n\n.. end-summary\n\n\n.. start-quickstart\n\nInstallation\n====================\n\nTo install Potnia, run the following command:\n\n.. code-block:: bash\n\n pip install potnia\n\nTo install the latest version from the repository, you can use this command:\n\n.. code-block:: bash\n\n pip install git+https://github.com/AncientNLP/potnia.git\n \nUsage\n====================\n\nTo convert transliterated Linear B to Linear B Unicode, use the following code:\n\n.. code-block:: python\n\n >>> from potnia import linear_b\n >>> linear_b(\"a-ri-to-jo\")\n '\ud800\udc00\ud800\udc2a\ud800\udc35\ud800\udc0d'\n\n\nIf you wish to regularize the text to remove additional annotations present in the `LiBER <https://liber.cnr.it/index>`_ \nand `D\u0100MOS <https://damos.hf.uio.no/about/content/>`_ transliteration, use the following code:\n\n.. code-block:: python\n\n >>> linear_b(\"e-ke-qe ]-o-na-to , ke-ke-me-na\u231e \u231fko-to-na GRA qs ] vac.\", regularize=True)\n '\ud800\udc01\ud800\udc10\ud800\udc24 %\ud800\udc03\ud800\udc19\ud800\udc35 \ud800\udc10\ud800\udc10\ud800\udc15\ud800\udc19 \ud800\udc12\ud800\udc35\ud800\udc19 \ud800\udc8e %'\n\nNote that uncertain/missing signs or sections of text are presently being replaced with a wildcard '%' character.\n\nTo tokenize transliterated Linear B texts without converting it to Unicode, use the following code:\n\n.. code-block:: python\n\n >>> linear_b.tokenize_transliteration(\"]wa VIR 1 MUL 2 'ko-wa 1' ko-wo 1\")\n [']', 'wa', ' ', 'VIR', ' ', '1', ' ', 'MUL', ' ', '2', ' ', \"'\", 'ko', 'wa', ' ', '1', \"'\", ' ', 'ko', 'wo', ' ', '1']\n\nCommand Line Interface (CLI)\n============================\n\nPotnia also provides a command line interface (CLI).\n\nTo convert transliterated Linear B to Unicode, use the following command:\n\n.. code-block:: bash\n\n potnia linear-b \"a-ri-to-jo\"\n\nTo regularize the text, use the following command:\n\n.. code-block:: bash\n\n potnia linear-b \"e-ke-qe ]-o-na-to , ke-ke-me-na\u231e \u231fko-to-na GRA qs ] vac.\" --regularize\n\nTo see the full set of commands available in the CLI, use the following command:\n\n.. code-block:: bash\n\n potnia --help\n\nGraphical User Interface (GUI)\n==============================\n\n.. image:: https://raw.githubusercontent.com/AncientNLP/potnia/main/docs/_static/img/potnia-gui.png\n\nPotnia also provides a graphical user interface (GUI). To start it, run:\n\n.. code-block:: bash\n\n potnia gui\n\nThis will show a link in the terminal that you can click on to open the GUI in your browser.\n\n \n.. end-quickstart\n\nCredits\n====================\n\n.. start-credits\n\nPotnia is developed by:\n\n- Emily Tour (University of Melbourne)\n- `Kabir Manandhar Shrestha <https://findanexpert.unimelb.edu.au/profile/892683-kabir-manandhar-shrestha>`_ (Melbourne Data Analytics Platform, University of Melbourne)\n- `Dr Robert Turnbull <https://findanexpert.unimelb.edu.au/profile/877006-robert-turnbull>`_ (Melbourne Data Analytics Platform, University of Melbourne)\n\n.. end-credits",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Potnia is an open-source Python library designed to convert Romanized transliterations of ancient texts into Unicode representations of ther respective native scripts..",
"version": "0.3.2",
"project_urls": {
"Documentation": "https://AncientNLP.github.io/potnia",
"Homepage": "https://github.com/AncientNLP/potnia/",
"Repository": "https://github.com/AncientNLP/potnia/"
},
"split_keywords": [
"linear a",
" linear b",
" sumerian",
" akkadian",
" cuneiform",
" unicode"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa805604daab68271231c568b3768ccd9510115692995b21832907c19e0d4185",
"md5": "f867bfcbeb7391c62ba7ebd65e34fbe4",
"sha256": "c8c19e34f82fc60128e095abbd0332f1c7aa356618dd6e0f06aacbab2dc587d9"
},
"downloads": -1,
"filename": "potnia-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f867bfcbeb7391c62ba7ebd65e34fbe4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 31871,
"upload_time": "2024-11-02T09:55:50",
"upload_time_iso_8601": "2024-11-02T09:55:50.871431Z",
"url": "https://files.pythonhosted.org/packages/fa/80/5604daab68271231c568b3768ccd9510115692995b21832907c19e0d4185/potnia-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e3205d467e05d5af2c24237b9e710c6fa2344a7f96731475ef3e3ad66a51a110",
"md5": "a7e5aacff46003758df41f71170ce104",
"sha256": "97b2e9b3ee6b631f414143cd7a588140c54cdca65c1f347509aa5f95092d52c5"
},
"downloads": -1,
"filename": "potnia-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "a7e5aacff46003758df41f71170ce104",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 27183,
"upload_time": "2024-11-02T09:55:52",
"upload_time_iso_8601": "2024-11-02T09:55:52.293324Z",
"url": "https://files.pythonhosted.org/packages/e3/20/5d467e05d5af2c24237b9e710c6fa2344a7f96731475ef3e3ad66a51a110/potnia-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 09:55:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AncientNLP",
"github_project": "potnia",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "potnia"
}
JSON
