Metadata-Version: 2.1
Name: indiek-gui
Version: 0.0.5
Summary: Tkinter GUI for IndieK
Home-page: https://pypi.org/project/indiek-gui/
Author: Adrian Ernesto Radillo
Author-email: adrian.radillo@gmail.com
License: GNU Affero General Public License v3.0
Project-URL: GitHub, https://github.com/indiek/indiek-gui
Project-URL: Documentation, https://indiekgui.readthedocs.io/en/latest/
Requires-Python: >=3.8
Provides-Extra: dev
License-File: LICENSE

Tkinter app that acts as a GUI for IndieK software.

============
Installation
============

To install from PyPI: ``pip install indiek-gui``

To develop, use the [dev] dependency specification, e.g.:
``pip install indiek-gui[dev]``

Or from the cloned repo's top-level in editable mode:
``pip install -e .[dev]``

==========
Quickstart
==========
Call ``indiek-gui`` from your terminal to launch the GUI.

..  code-block:: bash

    indiek-gui

This GUI enables you to create definitions, theorems and proofs,
and store them on an mock Database. It offers you the possibility
to persist the mock database to your file system as a JSON file, 
and to reload it later on.

=====
Tests
=====
To run the full test suite, type the following from the top level of this repo:
``pytest``
