celestine


Namecelestine JSON
Version 2024.6.9 PyPI version JSON
download
home_pageNone
SummaryA python framework for desktop applications.
upload_time2024-06-09 19:22:32
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords python application wrapper framework localization cross-platform offline desktop celestine image-viewer
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Célestine
#########
.. image:: https://readthedocs.org/projects/celestine/badge/?version=latest
   :target: https://celestine.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. image:: https://img.shields.io/github/repo-size/mem-dixy/celestine
   :alt: GitHub repo size
.. image:: https://img.shields.io/pypi/v/celestine
   :alt: PyPI - Version
   :target: https://pypi.org/project/celestine/
.. image:: https://img.shields.io/pypi/l/celestine
   :alt: PyPI - License
   :target: https://eupl.eu/
.. image:: https://img.shields.io/badge/calver-YYYY.MM.DD-22bfda.svg
   :alt: Calendar Versioning
   :target: https://calver.org/
.. image:: https://app.deepsource.com/gh/mem-dixy/celestine.svg/?label=active+issues&show_trend=false&token=1MUQkPi-6MM_PMqnaWrAJ6c7
  :target: https://app.deepsource.com/gh/mem-dixy/celestine/

A python framework for desktop applications.
Featuring support for multiple graphical user interfaces.
Localized for members of the European Union.


About
*****
The only requirement is Python.
However, you can install additional packages for extended functionality.

This has also been designed to run as a `Blender Add-on`_!
Note that Blender is an isolated environment, so other packages can not be used with it.

Project Update
^^^^^^^^^^^^^^
It seems that every release is broken in some form or another.
My plan of "just fix everything and then release it" has not been working out.
My new realization is that, since this is still in Alpha, it is okay that it is not perfect.
So I'm going to be releasing it "AS IS" for a while until Beta, where everything should be functioning as expected.
(The idea being that pushing out a semi-working package is better then leaving up a totaly broken package.)

Curently "pillow" and "platformdirs" are required dependencies because I have not made the workarounds yet.
Blender just dropped support for Python 3.10 and so I am going to be as well.
I would have liked to have a functioning Python 3.10 version so anyone who downloads this wont get errors, but it just hasn't happened yet.

In todays build, only pygame and tkinter are fully functional, using the "demo" and "viewer" applications.
(Unless there is another issue with the font file, then pygame wont work.)
Blender fails because it can't find the Pillow package, and it was having issues drawing images properly anyways.
Curses was having issues with windows-curses for a while, so I have not worked on it recently.
The DearPyGui Package seems to be nearly abandoned so I have not spent the time keeping it up to date.


.. _`Blender Add-on`: https://docs.blender.org/manual/en/latest/editors/preferences/addons.html


Commands
********


Applications
^^^^^^^^^^^^
Built in application to try out.

+-------------+-------------------------+------------------------------------------------------------------+
| Application | Command                 | Information                                                      |
+=============+=========================+==================================================================+
| Clean       | celestine -a clean      | Runs several code formatting  tools to get ready for publishing. |
+-------------+-------------------------+------------------------------------------------------------------+
| Demo        | celestine -a demo       | Test application for changing screens with buttons.              |
+-------------+-------------------------+------------------------------------------------------------------+
| Translator  | celestine -a translator | Translate the default language file into the 24 other languages. |
+-------------+-------------------------+------------------------------------------------------------------+
| Viewer      | celestine -a viewer     | Test application for viewing a limited number of images.         |
+-------------+-------------------------+------------------------------------------------------------------+

Caution: By default the viewer application will try to load every image it finds begining with the current working directory.


Graphical User Interfaces
^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------+------------------------------+--------------+
| Interface    | Source                       | Command      |
+==============+==============================+==============+
| `blender`_   | Blender Foundation [1]_      | -i blender   |
+--------------+------------------------------+--------------+
| `curses`_    | Python Standard Library [2]_ | -i curses    |
+--------------+------------------------------+--------------+
| `dearpygui`_ | Python Package Index         | -i dearpygui |
+--------------+------------------------------+--------------+
| `pygame`_    | Python Package Index         | -i pygame    |
+--------------+------------------------------+--------------+
| `tkinter`_   | Python Standard Library [3]_ | -i tkinter   |
+--------------+------------------------------+--------------+


Natural Languages
^^^^^^^^^^^^^^^^^
+------------+------------------+---------+
| Language   | Translation [4]_ | Command |
+============+==================+=========+
| Bulgarian  | български        | -l bg   |
+------------+------------------+---------+
| Czech      | čeština          | -l cs   |
+------------+------------------+---------+
| Danish     | dansk            | -l da   |
+------------+------------------+---------+
| German     | Deutsch          | -l de   |
+------------+------------------+---------+
| Greek      | ελληνικά         | -l el   |
+------------+------------------+---------+
| English    | English          | -l en   |
+------------+------------------+---------+
| Spanish    | español          | -l es   |
+------------+------------------+---------+
| Estonian   | eesti            | -l et   |
+------------+------------------+---------+
| Finnish    | suomi            | -l fi   |
+------------+------------------+---------+
| French     | français         | -l fr   |
+------------+------------------+---------+
| Irish      | Gaeilge          | -l ga   |
+------------+------------------+---------+
| Croatian   | hrvatski         | -l hr   |
+------------+------------------+---------+
| Hungarian  | magyar           | -l hu   |
+------------+------------------+---------+
| Italian    | italiano         | -l it   |
+------------+------------------+---------+
| Lithuanian | lietuvių         | -l lt   |
+------------+------------------+---------+
| Latvian    | latviešu         | -l lv   |
+------------+------------------+---------+
| Maltese    | Malti            | -l mt   |
+------------+------------------+---------+
| Dutch      | Nederlands       | -l nl   |
+------------+------------------+---------+
| Polish     | polski           | -l pl   |
+------------+------------------+---------+
| Portuguese | português        | -l pt   |
+------------+------------------+---------+
| Romanian   | română           | -l ro   |
+------------+------------------+---------+
| Slovak     | slovenčina       | -l sk   |
+------------+------------------+---------+
| Slovenian  | slovenščina      | -l sl   |
+------------+------------------+---------+
| Swedish    | svenska          | -l sv   |
+------------+------------------+---------+


Optional Dependencies
*********************
+------------------------+---------------------------------------------------+
| Package                | Description                                       |
+========================+===================================================+
| `dearpygui`_           | DearPyGui: A simple Python GUI Toolkit            |
+------------------------+---------------------------------------------------+
| `pygame`_              | Python Game Development                           |
+------------------------+---------------------------------------------------+
| `windows-curses`_ [5]_ | Support for the standard curses module on Windows |
+------------------------+---------------------------------------------------+
| `pillow`_              | Python Imaging Library (Fork)                     |
+------------------------+---------------------------------------------------+


Licences
********
The licence for :code:`Cascadia Code` is the
`SIL Open Font License <https://scripts.sil.org/OFL>`_.

The licence for :code:`celestine` is the
`European Union Public Licence <https://eupl.eu/>`_.


Project Links
*************
* `Discord <https://discord.gg/aNmDWPXd7B>`_
* `Documentation <https://celestine.readthedocs.io/>`_
* `Email <mem_dixy@pm.me>`_
* `Libraries.io <https://libraries.io/pypi/celestine>`_
* `PyPI <https://pypi.org/project/celestine/>`_
* `Source <https://github.com/mem-dixy/celestine>`_
* `Tracker <https://github.com/mem-dixy/celestine/issues>`_

.. _`dearpygui`: https://pypi.org/project/dearpygui/
.. _`pillow`: https://pypi.org/project/Pillow/
.. _`pygame`: https://pypi.org/project/pygame/
.. _`windows-curses`: https://pypi.org/project/windows-curses/

.. _`curses`: https://docs.python.org/3/library/curses.html
.. _`tkinter`: https://docs.python.org/3/library/tk.html

.. _`blender`: https://www.blender.org/


Footnotes
*********
.. [1] Blender interface can only be run when this is installed as a Blender addon.
.. [2] Windows does not come with Curses.
.. [3] Not always installed. Espically on Linix.
.. [4] Language files were translated from English using the Microsoft Azure Translator.
.. [5] Package only needed on Windows. Unix and Linix already have Curses.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "celestine",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "mem_dixy <mem_dixy@pm.me>",
    "keywords": "python, application, wrapper, framework, localization, cross-platform, offline, desktop, celestine, image-viewer",
    "author": null,
    "author_email": "mem_dixy <mem_dixy@pm.me>",
    "download_url": "https://files.pythonhosted.org/packages/05/b3/2bd8b35b429e9013c0f353d8c33dc8ba83fabb0d2640dd85005d9782dbd1/celestine-2024.6.9.tar.gz",
    "platform": null,
    "description": "C\u00e9lestine\r\n#########\r\n.. image:: https://readthedocs.org/projects/celestine/badge/?version=latest\r\n   :target: https://celestine.readthedocs.io/en/latest/?badge=latest\r\n   :alt: Documentation Status\r\n.. image:: https://img.shields.io/github/repo-size/mem-dixy/celestine\r\n   :alt: GitHub repo size\r\n.. image:: https://img.shields.io/pypi/v/celestine\r\n   :alt: PyPI - Version\r\n   :target: https://pypi.org/project/celestine/\r\n.. image:: https://img.shields.io/pypi/l/celestine\r\n   :alt: PyPI - License\r\n   :target: https://eupl.eu/\r\n.. image:: https://img.shields.io/badge/calver-YYYY.MM.DD-22bfda.svg\r\n   :alt: Calendar Versioning\r\n   :target: https://calver.org/\r\n.. image:: https://app.deepsource.com/gh/mem-dixy/celestine.svg/?label=active+issues&show_trend=false&token=1MUQkPi-6MM_PMqnaWrAJ6c7\r\n  :target: https://app.deepsource.com/gh/mem-dixy/celestine/\r\n\r\nA python framework for desktop applications.\r\nFeaturing support for multiple graphical user interfaces.\r\nLocalized for members of the European Union.\r\n\r\n\r\nAbout\r\n*****\r\nThe only requirement is Python.\r\nHowever, you can install additional packages for extended functionality.\r\n\r\nThis has also been designed to run as a `Blender Add-on`_!\r\nNote that Blender is an isolated environment, so other packages can not be used with it.\r\n\r\nProject Update\r\n^^^^^^^^^^^^^^\r\nIt seems that every release is broken in some form or another.\r\nMy plan of \"just fix everything and then release it\" has not been working out.\r\nMy new realization is that, since this is still in Alpha, it is okay that it is not perfect.\r\nSo I'm going to be releasing it \"AS IS\" for a while until Beta, where everything should be functioning as expected.\r\n(The idea being that pushing out a semi-working package is better then leaving up a totaly broken package.)\r\n\r\nCurently \"pillow\" and \"platformdirs\" are required dependencies because I have not made the workarounds yet.\r\nBlender just dropped support for Python 3.10 and so I am going to be as well.\r\nI would have liked to have a functioning Python 3.10 version so anyone who downloads this wont get errors, but it just hasn't happened yet.\r\n\r\nIn todays build, only pygame and tkinter are fully functional, using the \"demo\" and \"viewer\" applications.\r\n(Unless there is another issue with the font file, then pygame wont work.)\r\nBlender fails because it can't find the Pillow package, and it was having issues drawing images properly anyways.\r\nCurses was having issues with windows-curses for a while, so I have not worked on it recently.\r\nThe DearPyGui Package seems to be nearly abandoned so I have not spent the time keeping it up to date.\r\n\r\n\r\n.. _`Blender Add-on`: https://docs.blender.org/manual/en/latest/editors/preferences/addons.html\r\n\r\n\r\nCommands\r\n********\r\n\r\n\r\nApplications\r\n^^^^^^^^^^^^\r\nBuilt in application to try out.\r\n\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n| Application | Command                 | Information                                                      |\r\n+=============+=========================+==================================================================+\r\n| Clean       | celestine -a clean      | Runs several code formatting  tools to get ready for publishing. |\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n| Demo        | celestine -a demo       | Test application for changing screens with buttons.              |\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n| Translator  | celestine -a translator | Translate the default language file into the 24 other languages. |\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n| Viewer      | celestine -a viewer     | Test application for viewing a limited number of images.         |\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n\r\nCaution: By default the viewer application will try to load every image it finds begining with the current working directory.\r\n\r\n\r\nGraphical User Interfaces\r\n^^^^^^^^^^^^^^^^^^^^^^^^^\r\n+--------------+------------------------------+--------------+\r\n| Interface    | Source                       | Command      |\r\n+==============+==============================+==============+\r\n| `blender`_   | Blender Foundation [1]_      | -i blender   |\r\n+--------------+------------------------------+--------------+\r\n| `curses`_    | Python Standard Library [2]_ | -i curses    |\r\n+--------------+------------------------------+--------------+\r\n| `dearpygui`_ | Python Package Index         | -i dearpygui |\r\n+--------------+------------------------------+--------------+\r\n| `pygame`_    | Python Package Index         | -i pygame    |\r\n+--------------+------------------------------+--------------+\r\n| `tkinter`_   | Python Standard Library [3]_ | -i tkinter   |\r\n+--------------+------------------------------+--------------+\r\n\r\n\r\nNatural Languages\r\n^^^^^^^^^^^^^^^^^\r\n+------------+------------------+---------+\r\n| Language   | Translation [4]_ | Command |\r\n+============+==================+=========+\r\n| Bulgarian  | \u0431\u044a\u043b\u0433\u0430\u0440\u0441\u043a\u0438        | -l bg   |\r\n+------------+------------------+---------+\r\n| Czech      | \u010de\u0161tina          | -l cs   |\r\n+------------+------------------+---------+\r\n| Danish     | dansk            | -l da   |\r\n+------------+------------------+---------+\r\n| German     | Deutsch          | -l de   |\r\n+------------+------------------+---------+\r\n| Greek      | \u03b5\u03bb\u03bb\u03b7\u03bd\u03b9\u03ba\u03ac         | -l el   |\r\n+------------+------------------+---------+\r\n| English    | English          | -l en   |\r\n+------------+------------------+---------+\r\n| Spanish    | espa\u00f1ol          | -l es   |\r\n+------------+------------------+---------+\r\n| Estonian   | eesti            | -l et   |\r\n+------------+------------------+---------+\r\n| Finnish    | suomi            | -l fi   |\r\n+------------+------------------+---------+\r\n| French     | fran\u00e7ais         | -l fr   |\r\n+------------+------------------+---------+\r\n| Irish      | Gaeilge          | -l ga   |\r\n+------------+------------------+---------+\r\n| Croatian   | hrvatski         | -l hr   |\r\n+------------+------------------+---------+\r\n| Hungarian  | magyar           | -l hu   |\r\n+------------+------------------+---------+\r\n| Italian    | italiano         | -l it   |\r\n+------------+------------------+---------+\r\n| Lithuanian | lietuvi\u0173         | -l lt   |\r\n+------------+------------------+---------+\r\n| Latvian    | latvie\u0161u         | -l lv   |\r\n+------------+------------------+---------+\r\n| Maltese    | Malti            | -l mt   |\r\n+------------+------------------+---------+\r\n| Dutch      | Nederlands       | -l nl   |\r\n+------------+------------------+---------+\r\n| Polish     | polski           | -l pl   |\r\n+------------+------------------+---------+\r\n| Portuguese | portugu\u00eas        | -l pt   |\r\n+------------+------------------+---------+\r\n| Romanian   | rom\u00e2n\u0103           | -l ro   |\r\n+------------+------------------+---------+\r\n| Slovak     | sloven\u010dina       | -l sk   |\r\n+------------+------------------+---------+\r\n| Slovenian  | sloven\u0161\u010dina      | -l sl   |\r\n+------------+------------------+---------+\r\n| Swedish    | svenska          | -l sv   |\r\n+------------+------------------+---------+\r\n\r\n\r\nOptional Dependencies\r\n*********************\r\n+------------------------+---------------------------------------------------+\r\n| Package                | Description                                       |\r\n+========================+===================================================+\r\n| `dearpygui`_           | DearPyGui: A simple Python GUI Toolkit            |\r\n+------------------------+---------------------------------------------------+\r\n| `pygame`_              | Python Game Development                           |\r\n+------------------------+---------------------------------------------------+\r\n| `windows-curses`_ [5]_ | Support for the standard curses module on Windows |\r\n+------------------------+---------------------------------------------------+\r\n| `pillow`_              | Python Imaging Library (Fork)                     |\r\n+------------------------+---------------------------------------------------+\r\n\r\n\r\nLicences\r\n********\r\nThe licence for :code:`Cascadia Code` is the\r\n`SIL Open Font License <https://scripts.sil.org/OFL>`_.\r\n\r\nThe licence for :code:`celestine` is the\r\n`European Union Public Licence <https://eupl.eu/>`_.\r\n\r\n\r\nProject Links\r\n*************\r\n* `Discord <https://discord.gg/aNmDWPXd7B>`_\r\n* `Documentation <https://celestine.readthedocs.io/>`_\r\n* `Email <mem_dixy@pm.me>`_\r\n* `Libraries.io <https://libraries.io/pypi/celestine>`_\r\n* `PyPI <https://pypi.org/project/celestine/>`_\r\n* `Source <https://github.com/mem-dixy/celestine>`_\r\n* `Tracker <https://github.com/mem-dixy/celestine/issues>`_\r\n\r\n.. _`dearpygui`: https://pypi.org/project/dearpygui/\r\n.. _`pillow`: https://pypi.org/project/Pillow/\r\n.. _`pygame`: https://pypi.org/project/pygame/\r\n.. _`windows-curses`: https://pypi.org/project/windows-curses/\r\n\r\n.. _`curses`: https://docs.python.org/3/library/curses.html\r\n.. _`tkinter`: https://docs.python.org/3/library/tk.html\r\n\r\n.. _`blender`: https://www.blender.org/\r\n\r\n\r\nFootnotes\r\n*********\r\n.. [1] Blender interface can only be run when this is installed as a Blender addon.\r\n.. [2] Windows does not come with Curses.\r\n.. [3] Not always installed. Espically on Linix.\r\n.. [4] Language files were translated from English using the Microsoft Azure Translator.\r\n.. [5] Package only needed on Windows. Unix and Linix already have Curses.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A python framework for desktop applications.",
    "version": "2024.6.9",
    "project_urls": {
        "Changelog": "https://github.com/mem-dixy/celestine/blob/main/changelog.rst",
        "Discord": "https://discord.gg/aNmDWPXd7B",
        "Documentation": "https://celestine.readthedocs.io/",
        "Source": "https://github.com/mem-dixy/celestine",
        "Tracker": "https://github.com/mem-dixy/celestine/issues"
    },
    "split_keywords": [
        "python",
        " application",
        " wrapper",
        " framework",
        " localization",
        " cross-platform",
        " offline",
        " desktop",
        " celestine",
        " image-viewer"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0f2cae60d840d9f2d1f6617bf3fbd430878424884b293a6dfbdd477873044f8f",
                "md5": "7c0c9f705455e5390b55851f1db18b05",
                "sha256": "b5fb166b0f46e90deebea3e2240d2c212acc049b4509ae0e982e7c5b1487d68c"
            },
            "downloads": -1,
            "filename": "celestine-2024.6.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c0c9f705455e5390b55851f1db18b05",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 540556,
            "upload_time": "2024-06-09T19:22:28",
            "upload_time_iso_8601": "2024-06-09T19:22:28.930511Z",
            "url": "https://files.pythonhosted.org/packages/0f/2c/ae60d840d9f2d1f6617bf3fbd430878424884b293a6dfbdd477873044f8f/celestine-2024.6.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05b32bd8b35b429e9013c0f353d8c33dc8ba83fabb0d2640dd85005d9782dbd1",
                "md5": "f3ca378414a98d3ca0d07bb516e157bd",
                "sha256": "0028ad22e266d5b74fe396025f51e49d35376cb6bd1b1bc60adf1d40be0a958a"
            },
            "downloads": -1,
            "filename": "celestine-2024.6.9.tar.gz",
            "has_sig": false,
            "md5_digest": "f3ca378414a98d3ca0d07bb516e157bd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 496597,
            "upload_time": "2024-06-09T19:22:32",
            "upload_time_iso_8601": "2024-06-09T19:22:32.437739Z",
            "url": "https://files.pythonhosted.org/packages/05/b3/2bd8b35b429e9013c0f353d8c33dc8ba83fabb0d2640dd85005d9782dbd1/celestine-2024.6.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-09 19:22:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mem-dixy",
    "github_project": "celestine",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "celestine"
}
        
Elapsed time: 0.26751s