Celestine Framework
###################
.. image:: https://readthedocs.org/projects/celestine/badge/?version=latest
:target: https://celestine.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
About
*****
A python framework for desktop applications.
Featuring support for multiple graphical user interfaces.
Localized for members of the European Union.
The only requirement is Python.
However, you can install additional packages for extended functionality.
It has three customizable directories. ``application``, ``interface``, ``language``.
Any modules added to them should automatically be detected.
Comes with the application that started it all, a primitive image viewer.
Installation
************
Celestine
^^^^^^^^^
Python Package Index
~~~~~~~~~~~~~~~~~~~~
Install from pip::
pip install celestine
GitHub
~~~~~~
https://github.com/mem-dixy/celestine
Python
^^^^^^
`Python`_ >= 3.11
~~~~~~~~~~~~~~~~~
The recommended option. Or you can install Blender instead.
Currently supports Python 3.11.
(Python 3.10 used to work until Typing was added.)
`Blender`_
~~~~~~~~~~
Or you can install Python instead.
Blender comes with a python interpreter, which means this can be run as a blender add-on.
(It used to work anyways. Doing anything in Blender is hard, so upkeep has fallen behind.)
Note that Blender is an isolated environment, so no other packages can be used with it.
Extensions
**********
If you are on Linux, you won’t have TKinter installed.
If you are on Windows, you won’t have curses installed.
For a better user experience, you may want to install these packages as well.
Note: Pygame has not yet been released for Python 3.11. Which is too bad because this currently does not run on Python 3.10.
+-------------------+----------------+------------------------------------------------------------------------+
| Package | pip install | Information |
+===================+================+========================================================================+
| `Dear PyGui`_ | dearpygui | DearPyGui: A simple Python GUI Toolkit. |
+-------------------+----------------+------------------------------------------------------------------------+
| `Pygame`_ | pygame | Python Game Development. |
+-------------------+----------------+------------------------------------------------------------------------+
| `Windows Curses`_ | windows-curses | Support for the standard curses module on Windows. |
+-------------------+----------------+------------------------------------------------------------------------+
Commands
********
Application
^^^^^^^^^^^
Sample application to try out.
Caution: By default the viewer application will try to load every image it finds starting with the current working directory.
+-------------+-------------------------+------------------------------------------------------------------+
| Application | Command | Information |
+=============+=========================+==================================================================+
| Demo | celestine -a demo | Change screens with two whole buttons. |
+-------------+-------------------------+------------------------------------------------------------------+
| Translator | celestine -a translator | Translate the default language file into the 24 other languages. |
+-------------+-------------------------+------------------------------------------------------------------+
| Viewer | celestine -a viewer | View a very small amount of pictures at once. |
+-------------+-------------------------+------------------------------------------------------------------+
Interface
^^^^^^^^^
These interfaces are fully working.
+---------------+-------------------------+------------------------+
| Interface | Type | Command |
+===============+=========================+========================+
| `Curses`_ | Python Standard Library | celestine -i curses |
+---------------+-------------------------+------------------------+
| `Dear PyGui`_ | Python Package Index | celestine -i dearpygui |
+---------------+-------------------------+------------------------+
| `Tkinter`_ | Python Standard Library | celestine -i tkinter |
+---------------+-------------------------+------------------------+
These interfaces are coming soon.
+---------------+-------------------------+------------------------+
| Interface | Type | Command |
+===============+=========================+========================+
| `Blender`_ | Application | celestine -i blender |
+---------------+-------------------------+------------------------+
| `Pygame`_ | Python Package Index | celestine -i pygame |
+---------------+-------------------------+------------------------+
Language
^^^^^^^^
Currently supported languages.
+------------+-------------+-----------------+
| Language | Translation | Command |
+============+=============+=================+
| Bulgarian | български | celestine -l en |
+------------+-------------+-----------------+
| Czech | čeština | celestine -l cs |
+------------+-------------+-----------------+
| Danish | dansk | celestine -l da |
+------------+-------------+-----------------+
| German | Deutsch | celestine -l de |
+------------+-------------+-----------------+
| Greek | ελληνικά | celestine -l el |
+------------+-------------+-----------------+
| English | English | celestine -l en |
+------------+-------------+-----------------+
| Spanish | español | celestine -l es |
+------------+-------------+-----------------+
| Estonian | eesti | celestine -l et |
+------------+-------------+-----------------+
| Finnish | suomi | celestine -l fi |
+------------+-------------+-----------------+
| French | français | celestine -l fr |
+------------+-------------+-----------------+
| Irish | Gaeilge | celestine -l ga |
+------------+-------------+-----------------+
| Croatian | hrvatski | celestine -l hr |
+------------+-------------+-----------------+
| Hungarian | magyar | celestine -l hu |
+------------+-------------+-----------------+
| Italian | italiano | celestine -l it |
+------------+-------------+-----------------+
| Lithuanian | lietuvių | celestine -l lt |
+------------+-------------+-----------------+
| Latvian | latviešu | celestine -l lv |
+------------+-------------+-----------------+
| Maltese | Malti | celestine -l mt |
+------------+-------------+-----------------+
| Dutch | Nederlands | celestine -l nl |
+------------+-------------+-----------------+
| Polish | polski | celestine -l pl |
+------------+-------------+-----------------+
| Portuguese | português | celestine -l pt |
+------------+-------------+-----------------+
| Romanian | română | celestine -l ro |
+------------+-------------+-----------------+
| Slovak | slovenčina | celestine -l sk |
+------------+-------------+-----------------+
| Slovenian | slovenščina | celestine -l sl |
+------------+-------------+-----------------+
| Swedish | svenska | celestine -l sv |
+------------+-------------+-----------------+
Resources
*********
Learn more at `Read the Docs`_.
Join the `Discord`_.
`Email`_ the author.
.. _`Blender`: https://www.blender.org/
.. _`Celestine`: https://pypi.org/project/celestine/
.. _`Curses`: https://docs.python.org/3/howto/curses.html
.. _`Dear PyGui`: https://github.com/hoffstadt/DearPyGui/
.. _`Discord`: https://discord.gg/aNmDWPXd7B
.. _`Email`: celestine@mem-dixy.ch
.. _`Python`: https://www.python.org/
.. _`Pygame`: https://www.pygame.org/
.. _`Read the Docs`: https://celestine.readthedocs.io/en/latest/
.. _`Tkinter`: https://docs.python.org/3/library/tk.html
.. _`Windows Curses`: https://github.com/zephyrproject-rtos/windows-curses/
Raw data
{
"_id": null,
"home_page": "https://github.com/mem-dixy/celestine",
"name": "celestine",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,application,wrapper,framework,localization,cross-platform,offline,desktop,celestine,image-viewer",
"author": "mem_dixy",
"author_email": "celestine@mem-dixy.ch",
"download_url": "https://files.pythonhosted.org/packages/6e/df/14d4437b5c60179c9602daff848bb454e110980c544cbbc2f6726ca65483/celestine-0.4.0.tar.gz",
"platform": "Desktop",
"description": "Celestine Framework\r\n###################\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\r\nAbout\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\nThe only requirement is Python.\r\nHowever, you can install additional packages for extended functionality.\r\n\r\nIt has three customizable directories. ``application``, ``interface``, ``language``.\r\nAny modules added to them should automatically be detected.\r\n\r\nComes with the application that started it all, a primitive image viewer.\r\n\r\nInstallation\r\n************\r\n\r\nCelestine\r\n^^^^^^^^^\r\n\r\nPython Package Index\r\n~~~~~~~~~~~~~~~~~~~~\r\n\r\nInstall from pip::\r\n\r\n pip install celestine\r\n\r\nGitHub\r\n~~~~~~\r\n\r\nhttps://github.com/mem-dixy/celestine\r\n\r\nPython\r\n^^^^^^\r\n\r\n`Python`_ >= 3.11\r\n~~~~~~~~~~~~~~~~~\r\n\r\nThe recommended option. Or you can install Blender instead.\r\n\r\nCurrently supports Python 3.11.\r\n(Python 3.10 used to work until Typing was added.)\r\n\r\n`Blender`_\r\n~~~~~~~~~~\r\n\r\nOr you can install Python instead.\r\n\r\nBlender comes with a python interpreter, which means this can be run as a blender add-on.\r\n(It used to work anyways. Doing anything in Blender is hard, so upkeep has fallen behind.)\r\n\r\nNote that Blender is an isolated environment, so no other packages can be used with it.\r\n\r\nExtensions\r\n**********\r\n\r\nIf you are on Linux, you won\u2019t have TKinter installed.\r\nIf you are on Windows, you won\u2019t have curses installed.\r\n\r\nFor a better user experience, you may want to install these packages as well.\r\n\r\nNote: Pygame has not yet been released for Python 3.11. Which is too bad because this currently does not run on Python 3.10.\r\n\r\n+-------------------+----------------+------------------------------------------------------------------------+\r\n| Package | pip install | Information |\r\n+===================+================+========================================================================+\r\n| `Dear PyGui`_ | dearpygui | DearPyGui: A simple Python GUI Toolkit. |\r\n+-------------------+----------------+------------------------------------------------------------------------+\r\n| `Pygame`_ | pygame | Python Game Development. |\r\n+-------------------+----------------+------------------------------------------------------------------------+\r\n| `Windows Curses`_ | windows-curses | Support for the standard curses module on Windows. |\r\n+-------------------+----------------+------------------------------------------------------------------------+\r\n\r\nCommands\r\n********\r\n\r\nApplication\r\n^^^^^^^^^^^\r\n\r\nSample application to try out.\r\n\r\nCaution: By default the viewer application will try to load every image it finds starting with the current working directory.\r\n\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n| Application | Command | Information |\r\n+=============+=========================+==================================================================+\r\n| Demo | celestine -a demo | Change screens with two whole 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 | View a very small amount of pictures at once. |\r\n+-------------+-------------------------+------------------------------------------------------------------+\r\n\r\nInterface\r\n^^^^^^^^^\r\n\r\nThese interfaces are fully working.\r\n\r\n+---------------+-------------------------+------------------------+\r\n| Interface | Type | Command |\r\n+===============+=========================+========================+\r\n| `Curses`_ | Python Standard Library | celestine -i curses |\r\n+---------------+-------------------------+------------------------+\r\n| `Dear PyGui`_ | Python Package Index | celestine -i dearpygui |\r\n+---------------+-------------------------+------------------------+\r\n| `Tkinter`_ | Python Standard Library | celestine -i tkinter |\r\n+---------------+-------------------------+------------------------+\r\n\r\nThese interfaces are coming soon.\r\n\r\n+---------------+-------------------------+------------------------+\r\n| Interface | Type | Command |\r\n+===============+=========================+========================+\r\n| `Blender`_ | Application | celestine -i blender |\r\n+---------------+-------------------------+------------------------+\r\n| `Pygame`_ | Python Package Index | celestine -i pygame | \r\n+---------------+-------------------------+------------------------+\r\n\r\nLanguage\r\n^^^^^^^^\r\n\r\nCurrently supported languages.\r\n\r\n+------------+-------------+-----------------+\r\n| Language | Translation | Command |\r\n+============+=============+=================+\r\n| Bulgarian | \u0431\u044a\u043b\u0433\u0430\u0440\u0441\u043a\u0438 | celestine -l en |\r\n+------------+-------------+-----------------+\r\n| Czech | \u010de\u0161tina | celestine -l cs |\r\n+------------+-------------+-----------------+\r\n| Danish | dansk | celestine -l da |\r\n+------------+-------------+-----------------+\r\n| German | Deutsch | celestine -l de |\r\n+------------+-------------+-----------------+\r\n| Greek | \u03b5\u03bb\u03bb\u03b7\u03bd\u03b9\u03ba\u03ac | celestine -l el |\r\n+------------+-------------+-----------------+\r\n| English | English | celestine -l en |\r\n+------------+-------------+-----------------+\r\n| Spanish | espa\u00f1ol | celestine -l es |\r\n+------------+-------------+-----------------+\r\n| Estonian | eesti | celestine -l et |\r\n+------------+-------------+-----------------+\r\n| Finnish | suomi | celestine -l fi |\r\n+------------+-------------+-----------------+\r\n| French | fran\u00e7ais | celestine -l fr |\r\n+------------+-------------+-----------------+\r\n| Irish | Gaeilge | celestine -l ga |\r\n+------------+-------------+-----------------+\r\n| Croatian | hrvatski | celestine -l hr |\r\n+------------+-------------+-----------------+\r\n| Hungarian | magyar | celestine -l hu |\r\n+------------+-------------+-----------------+\r\n| Italian | italiano | celestine -l it |\r\n+------------+-------------+-----------------+\r\n| Lithuanian | lietuvi\u0173 | celestine -l lt |\r\n+------------+-------------+-----------------+\r\n| Latvian | latvie\u0161u | celestine -l lv |\r\n+------------+-------------+-----------------+\r\n| Maltese | Malti | celestine -l mt |\r\n+------------+-------------+-----------------+\r\n| Dutch | Nederlands | celestine -l nl |\r\n+------------+-------------+-----------------+\r\n| Polish | polski | celestine -l pl |\r\n+------------+-------------+-----------------+\r\n| Portuguese | portugu\u00eas | celestine -l pt |\r\n+------------+-------------+-----------------+\r\n| Romanian | rom\u00e2n\u0103 | celestine -l ro |\r\n+------------+-------------+-----------------+\r\n| Slovak | sloven\u010dina | celestine -l sk |\r\n+------------+-------------+-----------------+\r\n| Slovenian | sloven\u0161\u010dina | celestine -l sl |\r\n+------------+-------------+-----------------+\r\n| Swedish | svenska | celestine -l sv |\r\n+------------+-------------+-----------------+\r\n\r\nResources\r\n*********\r\n\r\nLearn more at `Read the Docs`_.\r\n\r\nJoin the `Discord`_.\r\n\r\n`Email`_ the author.\r\n\r\n.. _`Blender`: https://www.blender.org/\r\n.. _`Celestine`: https://pypi.org/project/celestine/\r\n.. _`Curses`: https://docs.python.org/3/howto/curses.html\r\n.. _`Dear PyGui`: https://github.com/hoffstadt/DearPyGui/\r\n.. _`Discord`: https://discord.gg/aNmDWPXd7B\r\n.. _`Email`: celestine@mem-dixy.ch\r\n.. _`Python`: https://www.python.org/\r\n.. _`Pygame`: https://www.pygame.org/\r\n.. _`Read the Docs`: https://celestine.readthedocs.io/en/latest/\r\n.. _`Tkinter`: https://docs.python.org/3/library/tk.html\r\n.. _`Windows Curses`: https://github.com/zephyrproject-rtos/windows-curses/\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "EUPL 1.2",
"summary": "A simple image viewer.",
"version": "0.4.0",
"split_keywords": [
"python",
"application",
"wrapper",
"framework",
"localization",
"cross-platform",
"offline",
"desktop",
"celestine",
"image-viewer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "00c03793f8f4d1fb0cb0051f04ce23c6be033abf9785b9fdf1a0d1fdae38cd02",
"md5": "b63e003bd4f36a1308295cb8b14c61fd",
"sha256": "f7e215df322abb72443a9e388626fd3dfaad6204e88a9701fe3fae58f963b480"
},
"downloads": -1,
"filename": "celestine-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b63e003bd4f36a1308295cb8b14c61fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 94975,
"upload_time": "2023-01-17T22:48:05",
"upload_time_iso_8601": "2023-01-17T22:48:05.831009Z",
"url": "https://files.pythonhosted.org/packages/00/c0/3793f8f4d1fb0cb0051f04ce23c6be033abf9785b9fdf1a0d1fdae38cd02/celestine-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6edf14d4437b5c60179c9602daff848bb454e110980c544cbbc2f6726ca65483",
"md5": "b0cb1bd36df4b74be80831f87d302484",
"sha256": "d22266e8486f5f0f0a8e16849be3eb7ba60a390ba1ecce7b955a5058f6bef11b"
},
"downloads": -1,
"filename": "celestine-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "b0cb1bd36df4b74be80831f87d302484",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 64179,
"upload_time": "2023-01-17T22:48:08",
"upload_time_iso_8601": "2023-01-17T22:48:08.459767Z",
"url": "https://files.pythonhosted.org/packages/6e/df/14d4437b5c60179c9602daff848bb454e110980c544cbbc2f6726ca65483/celestine-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 22:48:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mem-dixy",
"github_project": "celestine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "celestine"
}
JSON
