Metadata-Version: 2.1
Name: celestine
Version: 2023.9.30
Summary: A simple image viewer.
Author-email: mem_dixy <celestine@mem-dixy.ch>
Maintainer-email: mem_dixy <mem_dixy@pm.me>
Project-URL: Discord, https://discord.gg/aNmDWPXd7B
Project-URL: Documentation, https://celestine.readthedocs.io/
Project-URL: Source, https://github.com/mem-dixy/celestine
Project-URL: Tracker, https://github.com/mem-dixy/celestine/issues
Keywords: python,application,wrapper,framework,localization,cross-platform,offline,desktop,celestine,image-viewer
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Natural Language :: Bulgarian
Classifier: Natural Language :: Croatian
Classifier: Natural Language :: Czech
Classifier: Natural Language :: Danish
Classifier: Natural Language :: Dutch
Classifier: Natural Language :: English
Classifier: Natural Language :: Finnish
Classifier: Natural Language :: French
Classifier: Natural Language :: German
Classifier: Natural Language :: Greek
Classifier: Natural Language :: Hungarian
Classifier: Natural Language :: Irish
Classifier: Natural Language :: Italian
Classifier: Natural Language :: Latvian
Classifier: Natural Language :: Lithuanian
Classifier: Natural Language :: Polish
Classifier: Natural Language :: Portuguese
Classifier: Natural Language :: Romanian
Classifier: Natural Language :: Slovak
Classifier: Natural Language :: Slovenian
Classifier: Natural Language :: Spanish
Classifier: Natural Language :: Swedish
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Multimedia :: Graphics :: Viewers
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENCE.txt
Requires-Dist: more-itertools >=9.0.0
Requires-Dist: Pillow >=9.0.0
Requires-Dist: platformdirs >=3.0.0
Provides-Extra: windows
Requires-Dist: dearpygui ; extra == 'windows'
Requires-Dist: pygame ; extra == 'windows'
Requires-Dist: windows-curses ; extra == 'windows'
Provides-Extra: application
Requires-Dist: requests ; extra == 'application'
Provides-Extra: distribution
Requires-Dist: build ; extra == 'distribution'
Requires-Dist: pip ; extra == 'distribution'
Requires-Dist: twine ; extra == 'distribution'
Provides-Extra: documentation
Requires-Dist: Sphinx ; extra == 'documentation'
Provides-Extra: macos
Requires-Dist: dearpygui ; extra == 'macos'
Requires-Dist: pygame ; extra == 'macos'
Provides-Extra: stubs
Requires-Dist: blender-stubs ; extra == 'stubs'
Requires-Dist: types-requests ; extra == 'stubs'
Provides-Extra: validation
Requires-Dist: black ; extra == 'validation'
Requires-Dist: coverage ; extra == 'validation'
Requires-Dist: flake8 ; extra == 'validation'
Requires-Dist: isort ; extra == 'validation'
Requires-Dist: mypy ; extra == 'validation'
Requires-Dist: pycodestyle ; extra == 'validation'
Requires-Dist: pylint ; extra == 'validation'
Requires-Dist: pyright ; extra == 'validation'

celestine
#########

.. 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/


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.

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.

.. _`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                  | celestine    | pip install         |
+=================+=========================+==============+=====================+
| `blender`_ [1]_ | Blender Foundation      | -i blender   |                     |
+-----------------+-------------------------+--------------+---------------------+
| `curses`_       | Python Standard Library | -i curses    | windows-curses [2]_ |
+-----------------+-------------------------+--------------+---------------------+
| `dearpygui`_    | Python Package Index    | -i dearpygui | dearpygui           |
+-----------------+-------------------------+--------------+---------------------+
| `pygame`_       | Python Package Index    | -i pygame    | pygame              |
+-----------------+-------------------------+--------------+---------------------+
| `tkinter`_      | Python Standard Library | -i tkinter   |                     |
+-----------------+-------------------------+--------------+---------------------+

Note:

.. [1] Blender interface can only be run when this is installed as a Blender addon.
.. [2] Package only needed on Windows. Unix and Linix already have Curses.

.. _`blender`: https://www.blender.org/
.. _`curses`: https://docs.python.org/3/howto/curses.html
.. _`dearpygui`: https://pypi.org/project/dearpygui/
.. _`pygame`: https://pypi.org/project/pygame/
.. _`pyupgrade`: https://pypi.org/project/pyupgrade/
.. _`tkinter`: https://docs.python.org/3/library/tk.html


Natural Languages
^^^^^^^^^^^^^^^^^

Languages translated from English using the Microsoft Azure Translator.

+------------+-------------+-----------------+
| Language   | Translation | Command         |
+============+=============+=================+
| Bulgarian  | български   | celestine -l bg |
+------------+-------------+-----------------+
| 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 |
+------------+-------------+-----------------+


Optional Dependencies
*********************

+-------------------+----------------+------------------------------------------------------------------------+
| Package           | pip install    | Information                                                            |
+===================+================+========================================================================+
| `dearpygui`_      | dearpygui      | DearPyGui: A simple Python GUI Toolkit.                                |
+-------------------+----------------+------------------------------------------------------------------------+
| `pygame`_         | pygame         | Python Game Development.                                               |
+-------------------+----------------+------------------------------------------------------------------------+
| `windows-curses`_ | windows-curses | Support for the standard curses module on Windows.                     |
+-------------------+----------------+------------------------------------------------------------------------+
| `Pillow`_         | Pillow         | Python Imaging Library (Fork)                                          |
+-------------------+----------------+------------------------------------------------------------------------+


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


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>`_
