{"id":22222199,"url":"https://github.com/davewalker5/hieroglyphics","last_synced_at":"2025-03-25T07:44:19.509Z","repository":{"id":132526237,"uuid":"566356380","full_name":"davewalker5/Hieroglyphics","owner":"davewalker5","description":"Simplistic transliteration of words and phrases entered in English to their hieroglyphic equivalent","archived":false,"fork":false,"pushed_at":"2025-03-11T14:20:41.000Z","size":4485,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T15:31:14.167Z","etag":null,"topics":["egypt","egyptian","egyptology","hieroglyphics","python","python3","transliteration"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davewalker5.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-15T13:59:57.000Z","updated_at":"2025-03-11T14:19:03.000Z","dependencies_parsed_at":"2023-05-31T22:01:25.482Z","dependency_job_id":"0df2c986-f497-4322-8d5d-2a5f5f3c511c","html_url":"https://github.com/davewalker5/Hieroglyphics","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davewalker5%2FHieroglyphics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davewalker5%2FHieroglyphics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davewalker5%2FHieroglyphics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davewalker5%2FHieroglyphics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davewalker5","download_url":"https://codeload.github.com/davewalker5/Hieroglyphics/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245422921,"owners_count":20612725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["egypt","egyptian","egyptology","hieroglyphics","python","python3","transliteration"],"created_at":"2024-12-02T23:17:29.803Z","updated_at":"2025-03-25T07:44:19.488Z","avatar_url":"https://github.com/davewalker5.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://github.com/davewalker5/Hieroglyphics/workflows/Python%20CI%20Build/badge.svg\n    :target: https://github.com/davewalker5/Hieroglyphics/actions\n    :alt: Build Status\n\n.. image:: https://codecov.io/gh/davewalker5/Hieroglyphics/branch/main/graph/badge.svg?token=U86UFDVD5S\n    :target: https://codecov.io/gh/davewalker5/Hieroglyphics\n    :alt: Coverage\n\n.. image:: https://sonarcloud.io/api/project_badges/measure?project=davewalker5_Hieroglyphics\u0026metric=alert_status\n    :target: https://sonarcloud.io/summary/new_code?id=davewalker5_Hieroglyphics\n    :alt: Quality Gate\n\n.. image:: https://img.shields.io/github/issues/davewalker5/Hieroglyphics\n    :target: https://github.com/davewalker5/Hieroglyphics/issues\n    :alt: GitHub issues\n\n.. image:: https://img.shields.io/github/v/release/davewalker5/Hieroglyphics.svg?include_prereleases\n    :target: https://github.com/davewalker5/Hieroglyphics/releases\n    :alt: Releases\n\n.. image:: https://img.shields.io/badge/License-mit-blue.svg\n    :target: https://github.com/davewalker5/Hieroglyphics/blob/main/LICENSE\n    :alt: License\n\n.. image:: https://img.shields.io/badge/language-python-blue.svg\n    :target: https://www.python.org\n    :alt: Language\n\n.. image:: https://img.shields.io/github/languages/code-size/davewalker5/Hieroglyphics\n    :target: https://github.com/davewalker5/Hieroglyphics/\n    :alt: GitHub code size in bytes\n\n\nEnglish to Hieroglyphics Transliterator\n=======================================\n\nThe English to hieroglyphics transliterator is an application for performing a simplistic transliteration of words\nand phrases entered in English to their hieroglyphic equivalent.\n\nStructure\n=========\n\n+-------------------------------+----------------------------------------------------------------------+\n| **Package**                   | **Contents**                                                         |\n+-------------------------------+----------------------------------------------------------------------+\n| hieroglyphics.transliteration | Business logic for the application                                   |\n+-------------------------------+----------------------------------------------------------------------+\n| hieroglyphics.web             | A simple Flask-based web site providing a user-interface             |\n+-------------------------------+----------------------------------------------------------------------+\n\nRunning the Application\n=======================\n\nPre-requisites\n--------------\n\nTo run the application, a virtual environment should be created, the requirements should be installed using pip and the\nenvironment should be activated.\n\nRunning the Web Application\n---------------------------\n\nTo run the web-based application in the Flask development web server, enter the following from the root of the working\ncopy of the project:\n\n::\n    export PYTHONPATH=`pwd`/src\n    export FLASK_DEBUG=1\n    python -m hieroglyphics\n\nThe first four commands will need to be modified based on the current operating system. Once the development server\nis running, browse to the following URL in a  web browser:\n\n::\n\n    http://127.0.0.1:5000/\n\n\nUnit Tests and Coverage\n=======================\n\nTo run the unit tests, a virtual environment should be created, the requirements should be installed using pip and the\nenvironment should be activated.\n\nThe tests can then be run from the command line, at the root of the project folder, as follows:\n\n::\n\n    export PYTHONPATH=`pwd`/src/\n    python -m pytest\n\nThe first command adds the source folder, containing the packages under test, to the PYTHONPATH environment\nvariable so the packages will be found when the tests attempt to import them. The command will need to be modified\nbased on the current operating system.\n\nSimilarly, a coverage report can be generated by running the following commands from the root of the project folder:\n\n::\n\n    export PYTHONPATH=`pwd`/src/\n    python -m pytest --cov=src --cov-branch --cov-report html\n\nThis will create a folder \"htmlcov\" containing the coverage report in HTML format.\n\nGenerating Documentation\n========================\n\nTo generate the documentation, a virtual environment should be created, the requirements should be installed\nusing pip and the environment should be activated.\n\nHTML documentation can then be created by running the following commands from the \"docs\" sub-folder:\n\n::\n\n    export PYTHONPATH=`pwd`/../src/\n    make html\n\nThe resulting documentation is written to the docs/build/html folder and can be viewed by opening \"index.html\" in a\nweb browser.\n\n\nDependencies\n============\n\nThe application has dependencies listed in requirements.txt.\n\n\nDistribution\n============\n\nA distribution can be created by running the following from a command prompt at the root of the project:\n\n::\n\n    pip install wheel\n    python setup.py bdist_wheel\n\nNote that the project's virtual environment should **not** be activated when creating distributions.\n\n\nLicense\n=======\n\nThis software is licensed under the MIT License:\n\nhttps://opensource.org/licenses/MIT\n\nCopyright 2022 David Walker\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the\nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavewalker5%2Fhieroglyphics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavewalker5%2Fhieroglyphics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavewalker5%2Fhieroglyphics/lists"}