mininterface 0.8.0__tar.gz → 1.0.0__tar.gz

mininterface-1.0.0/PKG-INFO

@@ -0,0 +1,338 @@
+Metadata-Version: 2.3
+Name: mininterface
+Version: 1.0.0
+Summary: A minimal access to GUI, TUI, CLI and config
+License: LGPL-3.0-or-later
+Author: Edvard Rejthar
+Author-email: edvard.rejthar@nic.cz
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: all
+Provides-Extra: basic
+Provides-Extra: gui
+Provides-Extra: img
+Provides-Extra: tui
+Provides-Extra: ui
+Provides-Extra: web
+Requires-Dist: annotated-types
+Requires-Dist: autocombobox (==1.4.2) ; extra == "gui" or extra == "ui" or extra == "all"
+Requires-Dist: humanize ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: pillow ; extra == "img" or extra == "gui" or extra == "ui" or extra == "all"
+Requires-Dist: pyyaml ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: simple_term_menu
+Requires-Dist: textual (<2.0.0) ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: textual-serve ; extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: textual_imageview ; extra == "img" or extra == "tui" or extra == "ui" or extra == "all"
+Requires-Dist: tkcalendar ; extra == "gui" or extra == "ui" or extra == "all"
+Requires-Dist: tkinter-tooltip ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: tkinter_form (==0.2.1) ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: tkscrollableframe ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Requires-Dist: tyro (>=0.9,<0.10) ; extra == "basic" or extra == "img" or extra == "tui" or extra == "gui" or extra == "web" or extra == "ui" or extra == "all"
+Project-URL: Homepage, https://github.com/CZ-NIC/mininterface
+Description-Content-Type: text/markdown
+
+# Mininterface – access to GUI, TUI, web, CLI and config files
+[![Build Status](https://github.com/CZ-NIC/mininterface/actions/workflows/run-unittest.yml/badge.svg)](https://github.com/CZ-NIC/mininterface/actions)
+[![Downloads](https://static.pepy.tech/badge/mininterface)](https://pepy.tech/project/mininterface)
+
+Write the program core, do not bother with the input/output.
+
+![Hello world example: GUI window](https://github.com/CZ-NIC/mininterface/blob/main/asset/hello-gui.avif?raw=True "A minimal use case – GUI")
+![Hello world example: TUI fallback](https://github.com/CZ-NIC/mininterface/blob/main/asset/hello-tui.avif?raw=True "A minimal use case – TUI fallback")
+
+Check out the code, which is surprisingly short, that displays such a window or its textual fallback.
+
+```python
+from dataclasses import dataclass
+from mininterface import run
+
+@dataclass
+class Env:
+    """ This calculates something. """
+
+    my_flag: bool = False
+    """ This switches the functionality """
+
+    my_number: int = 4
+    """ This number is very important """
+
+if __name__ == "__main__":
+    m = run(Env, title="My application")
+    m.form()
+    # Attributes are suggested by the IDE
+    # along with the hint text 'This number is very important'.
+    print(m.env.my_number)
+```
+
+# Contents
+- [You got CLI](#you-got-cli)
+- [You got config file management](#you-got-config-file-management)
+- [You got dialogs](#you-got-dialogs)
+- [Background](#background)
+- [Installation](#installation)
+- [Docs](#docs)
+- [Gallery](#gallery)
+- [Examples](#examples)
+    * [Hello world](#hello-world)
+    * [Goodbye argparse world](#goodbye-argparse-world)
+
+## You got CLI
+It was all the code you need. No lengthy blocks of code imposed by an external dependency. Besides the GUI/TUI/web, you receive powerful YAML-configurable CLI parsing.
+
+
+```bash
+$ ./program.py --help
+usage: program.py [-h] [-v] [--my-flag | --no-my-flag] [--my-number INT]
+
+This calculates something.
+
+╭─ options ───────────────────────────────────────────────────────────────╮
+│ -h, --help             show this help message and exit                  │
+│ -v, --verbose          Verbosity level. Can be used twice to increase.  │
+│ --my-flag, --no-my-flag                                                 │
+│                        This switches the functionality (default: False) │
+│ --my-number INT        This number is very important (default: 4)       │
+╰─────────────────────────────────────────────────────────────────────────╯
+```
+
+## You got config file management
+Loading config file is a piece of cake. Alongside `program.py`, write some of its arguments to `program.yaml`. They are seamlessly taken as defaults.
+
+```yaml
+my_number: 555
+```
+
+```bash
+$ program.py --help
+...
+│ --my-number INT        This number is very important (default: 555)     │
+```
+
+## You got dialogs
+Check out several useful methods to handle user dialogs. Here we bound the interface to a `with` statement that redirects stdout directly to the window.
+
+```python
+with run(Env) as m:
+    print(f"Your important number is {m.env.my_number}")
+    boolean = m.confirm("Is that alright?")
+```
+
+![Small window with the text 'Your important number'](https://github.com/CZ-NIC/mininterface/blob/main/asset/hello-with-statement.webp?raw=True "With statement to redirect the output")
+![The same in terminal'](https://github.com/CZ-NIC/mininterface/blob/main/asset/hello-with-statement-tui.avif?raw=True "With statement in TUI fallback")
+
+# Background
+
+Wrapper between various libraries that provide a user interface.
+
+Writing a small and useful program might be a task that takes fifteen minutes. Adding a CLI to specify the parameters is not so much overhead. But building a simple GUI around it? HOURS! Hours spent on researching GUI libraries, wondering why the Python desktop app ecosystem lags so far behind the web world. All you need is a few input fields validated through a clickable window... You do not deserve to add hundred of lines of the code just to define some editable fields. *Mininterface* is here to help.
+
+The config variables needed by your program are kept in cozy dataclasses. Write less! The syntax of [tyro](https://github.com/brentyi/tyro) does not require any overhead (as its `argparse` alternatives do). You just annotate a class attribute, append a simple docstring and get a fully functional application:
+
+* Call it as `program.py --help` to display full help.
+* Use any flag in CLI: `program.py --my-flag`  causes `env.my_flag` be set to `True`.
+* The main benefit: Launch it without parameters as `program.py` to get a fully working window with all the flags ready to be edited.
+* Running on a remote machine? Automatic regression to the text interface.
+* Or access your program via [web browser](http://127.0.0.1:8000/Interfaces/#webinterface-or-web).
+
+# Installation
+
+Install with a single command from [PyPi](https://pypi.org/project/mininterface/).
+
+```bash
+pip install mininterface[all]  # GPLv3 and compatible
+```
+
+## Bundles
+
+There are various bundles. We mark the least permissive licence in the bundle.
+
+| bundle | size | licence | description |
+| ------ | ---- | ----------- | ---- |
+| mininterface | 1 MB | LGPL | minimal – only text dialogs |
+| mininterface[basic] | 25 MB | LGPL | CLI, GUI, TUI |
+| mininterface[web] | 40 MB | LGPL | including [WebInterface](Interfaces.md#webinterface-or-web) |
+| mininterface[img] | 40 MB | LGPL | images |
+| mininterface[tui] | 40 MB | LGPL | images |
+| mininterface[gui] | 70 MB | GPL | images, combobox, calendar |
+| mininterface[ui] | 90 MB | GPL | full installation |
+| mininterface[all] | 90 MB | GPL | full installation, same as `ui`, reserved for future use (big dependencies, optional interfaces) |
+
+Apart from the minimal bundle (which lacks CLI and dataclass support), they have the same functionality, differring only in the user experience.
+
+!!! tip
+  For automated testing (e.g., in CI environments), the `mininterface[basic]` bundle is sufficient.
+
+## MacOS GUI
+
+If the GUI does not work on MacOS, you might need to launch: `brew install python-tk`
+
+# Docs
+See the docs overview at [https://cz-nic.github.io/mininterface/](https://cz-nic.github.io/mininterface/Overview/).
+
+# Gallery
+
+These projects have the code base reduced thanks to the mininterface:
+
+* **[deduplidog](https://github.com/CZ-NIC/deduplidog/)** – Find duplicates in a scattered directory structure
+* **[touch-timestamp](https://github.com/CZ-NIC/touch-timestamp/)** – A powerful dialog to change the files' timestamp
+
+# Examples
+## Hello world
+
+Take a look at the following example.
+
+1. We define any Env class.
+2. Then, we initialize mininterface with [`run(Env)`][mininterface.run] – the missing fields will be prompter for
+3. Then, we use various dialog methods, like [`confirm`][mininterface.Mininterface.confirm], [`choice`][mininterface.Mininterface.select] or [`form`][mininterface.Mininterface.form].
+
+Below, you find the screenshots how the program looks in various environments ([graphic](Interfaces.md#guiinterface-or-tkinterface-or-gui) interface, [web](Interfaces.md#webinterface-or-web) interface...).
+
+```python
+from dataclasses import dataclass
+from pathlib import Path
+from mininterface import run
+
+@dataclass
+class Env:
+  my_file: Path  # This is my help text
+  my_flag: bool = False
+  my_number: int = 4
+
+if __name__ == "__main__":
+    # Here, the user will be prompted
+    # for missing parameters (`my_file`) automatically
+    with run(Env) as m:
+
+      # You can lean on the typing
+      # Ex. directly read from the file object:
+      print("The file contents:", m.env.my_file.read_text())
+
+      # You can use various dialog methods,
+      # like `confirm` for bool
+      if m.confirm("Do you want to continue?"):
+
+        # or `choice` for choosing a value
+        fruit = m.select(("apple", "banana", "sirup"), "Choose a fruit")
+
+        if fruit == "apple":
+          # or `form` for an arbitrary values
+          m.form({
+            "How many": 0,
+            "Choose another file": m.env.my_file
+          })
+```
+
+Launch with `./program.py`:
+
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_tk1.avif?raw=True)
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_tk2.avif?raw=True)
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_tk3.avif?raw=True)
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_tk4.avif?raw=True)
+
+Or at the remote machine `MININTERFACE_INTERFACE=tui ./program.py`:
+
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_textual1.avif?raw=True)
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_textual2.avif?raw=True)
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_textual3.avif?raw=True)
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_textual4.avif?raw=True)
+
+Or via the plain text `MININTERFACE_INTERFACE=text ./program.py`:
+
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_text.avif?raw=True)
+
+Or via web browser `MININTERFACE_INTERFACE=web ./program.py`:
+
+![Tutorial](https://github.com/CZ-NIC/mininterface/blob/main/asset/tutorial_web.avif?raw=True)
+
+You can always set Env via CLI or a config file:
+
+```bash
+$ ./program.py --help
+usage: program.py [-h] [OPTIONS]
+
+╭─ options ──────────────────────────────────────────────────────────────╮
+│ -h, --help             show this help message and exit                 │
+│ -v, --verbose          Verbosity level. Can be used twice to increase. │
+│ --my-file PATH         This is my help text (required)                 │
+│ --my-flag, --no-my-flag                                                │
+│                        (default: False)                                │
+│ --my-number INT        (default: 4)                                    │
+╰────────────────────────────────────────────────────────────────────────╯
+```
+
+## Goodbye argparse world
+
+You want to try out the Mininterface with your current [`ArgumentParser`](https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser)?
+
+You're using positional arguments, subparsers, types in the ArgumentParser... Mininterface will give you immediate benefit. Just wrap it inside the [`run`][mininterface.run] method.
+
+```python
+#!/usr/bin/env python3
+from argparse import ArgumentParser
+from datetime import time
+from pathlib import Path
+
+from mininterface import run
+
+parser = ArgumentParser()
+parser.add_argument("input_file", type=Path, help="Path to the input file.")
+parser.add_argument("--time", type=time, help="Given time")
+subparsers = parser.add_subparsers(dest="command", required=True)
+sub1 = subparsers.add_parser("build", help="Build something.")
+sub1.add_argument("--optimize", action="store_true", help="Enable optimizations.")
+
+# Old version
+# env = parser.parse_args()
+# env.input_file  # a Path object
+
+# New version
+m = run(parser)
+m.env.input_file  # a Path object
+
+# Live edit of the fields
+m.form()
+```
+
+Now, the help text looks much better. Try it in the terminal to see the colours.
+
+```
+$ ./program.py --help
+usage: program.py [-h] [OPTIONS] PATH
+
+╭─ positional arguments ──────────────────────────────────────────────────╮
+│ PATH                    Path to the input file. (required)              │
+╰─────────────────────────────────────────────────────────────────────────╯
+╭─ options ───────────────────────────────────────────────────────────────╮
+│ -h, --help              show this help message and exit                 │
+│ -v, --verbose           Verbosity level. Can be used twice to increase. │
+│ --time HH:MM[:SS[…]]    Given time (default: 00:00:00)                  │
+╰─────────────────────────────────────────────────────────────────────────╯
+╭─ build options ─────────────────────────────────────────────────────────╮
+│ --build.optimize, --build.no-optimize                                   │
+│                         Enable optimizations. (default: False)          │
+╰─────────────────────────────────────────────────────────────────────────╯
+```
+
+And what happens when you launch the program? First, *Mininterface* asks you to provide the missing required arguments. Note the button to raise a file picker dialog.
+
+![Positional fields](https://github.com/CZ-NIC/mininterface/blob/main/asset/argparse_required.avif?raw=True)
+
+Then, a `.form()` call will create a dialog with all the fields.
+
+![Whole form](https://github.com/CZ-NIC/mininterface/blob/main/asset/argparse_form.avif?raw=True)
+
+You will access the arguments through [`m.env`][mininterface.Mininterface.env]
+
+```python
+print(m.env.time)  # -> 14:21
+```
+
+If you're sure enough to start using *Mininterface*, convert the argparse into a dataclass. Then, the IDE will auto-complete the hints as you type.
+
+!!! warning
+    Be aware that in contrast to the argparse, we create default values. This does make sense for most values but might pose a confusion for ex. `parser.add_argument("--path", type=Path)` which becomes `Path('.')`, not `None`.

mininterface-0.8.0/PKG-INFO → mininterface-1.0.0/README.md

@@ -1,41 +1,4 @@
-Metadata-Version: 2.3
-Name: mininterface
-Version: 0.8.0
-Summary: A minimal access to GUI, TUI, CLI and config
-License: LGPL-3.0-or-later
-Author: Edvard Rejthar
-Author-email: edvard.rejthar@nic.cz
-Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Provides-Extra: all
-Provides-Extra: gui
-Provides-Extra: img
-Provides-Extra: tui
-Provides-Extra: ui
-Provides-Extra: web
-Requires-Dist: autocombobox (==1.4.2) ; extra == "gui" or extra == "ui" or extra == "all"
-Requires-Dist: humanize
-Requires-Dist: pillow ; extra == "img" or extra == "gui" or extra == "ui" or extra == "all"
-Requires-Dist: pyyaml
-Requires-Dist: simple_term_menu
-Requires-Dist: textual (<2.0.0)
-Requires-Dist: textual-serve ; extra == "web" or extra == "ui" or extra == "all"
-Requires-Dist: textual_imageview ; extra == "img" or extra == "tui" or extra == "ui" or extra == "all"
-Requires-Dist: tkcalendar ; extra == "gui" or extra == "ui" or extra == "all"
-Requires-Dist: tkinter-tooltip
-Requires-Dist: tkinter_form (==0.2.1)
-Requires-Dist: tkscrollableframe
-Requires-Dist: typing_extensions
-Requires-Dist: tyro (>=0.9,<0.10)
-Project-URL: Homepage, https://github.com/CZ-NIC/mininterface
-Description-Content-Type: text/markdown
-
-# Mininterface – access to GUI, TUI, CLI and config files
+# Mininterface – access to GUI, TUI, web, CLI and config files
 [![Build Status](https://github.com/CZ-NIC/mininterface/actions/workflows/run-unittest.yml/badge.svg)](https://github.com/CZ-NIC/mininterface/actions)
 [![Downloads](https://static.pepy.tech/badge/mininterface)](https://pepy.tech/project/mininterface)
 
@@ -61,7 +24,7 @@ class Env:
     """ This number is very important """
 
 if __name__ == "__main__":
-    m = run(Env, prog="My application")
+    m = run(Env, title="My application")
     m.form()
     # Attributes are suggested by the IDE
     # along with the hint text 'This number is very important'.
@@ -71,20 +34,22 @@ if __name__ == "__main__":
 # Contents
 - [You got CLI](#you-got-cli)
 - [You got config file management](#you-got-config-file-management)
-- [You got dialogues](#you-got-dialogues)
+- [You got dialogs](#you-got-dialogs)
 - [Background](#background)
 - [Installation](#installation)
 - [Docs](#docs)
 - [Gallery](#gallery)
-- [Hello world](#hello-world)
+- [Examples](#examples)
+    * [Hello world](#hello-world)
+    * [Goodbye argparse world](#goodbye-argparse-world)
 
 ## You got CLI
-It was all the code you need. No lengthy blocks of code imposed by an external dependency. Besides the GUI/TUI, you receive powerful YAML-configurable CLI parsing.
+It was all the code you need. No lengthy blocks of code imposed by an external dependency. Besides the GUI/TUI/web, you receive powerful YAML-configurable CLI parsing.
 
 
 ```bash
 $ ./program.py --help
-usage: My application [-h] [-v] [--my-flag | --no-my-flag] [--my-number INT]
+usage: program.py [-h] [-v] [--my-flag | --no-my-flag] [--my-number INT]
 
 This calculates something.
 
@@ -98,7 +63,7 @@ This calculates something.
 ```
 
 ## You got config file management
-Loading config file is a piece of cake. Alongside `program.py`, put `program.yaml` and put there some of the arguments. They are seamlessly taken as defaults.
+Loading config file is a piece of cake. Alongside `program.py`, write some of its arguments to `program.yaml`. They are seamlessly taken as defaults.
 
 ```yaml
 my_number: 555
@@ -110,13 +75,13 @@ $ program.py --help
 │ --my-number INT        This number is very important (default: 555)     │
 ```
 
-## You got dialogues
-Check out several useful methods to handle user dialogues. Here we bound the interface to a `with` statement that redirects stdout directly to the window.
+## You got dialogs
+Check out several useful methods to handle user dialogs. Here we bound the interface to a `with` statement that redirects stdout directly to the window.
 
 ```python
 with run(Env) as m:
     print(f"Your important number is {m.env.my_number}")
-    boolean = m.is_yes("Is that alright?")
+    boolean = m.confirm("Is that alright?")
 ```
 
 ![Small window with the text 'Your important number'](https://github.com/CZ-NIC/mininterface/blob/main/asset/hello-with-statement.webp?raw=True "With statement to redirect the output")
@@ -126,13 +91,13 @@ with run(Env) as m:
 
 Wrapper between various libraries that provide a user interface.
 
-Writing a small and useful program might be a task that takes fifteen minutes. Adding a CLI to specify the parameters is not so much overhead. But building a simple GUI around it? HOURS! Hours spent on researching GUI libraries, wondering why the Python desktop app ecosystem lags so far behind the web world. All you need is a few input fields validated through a clickable window... You do not deserve to add hundred of lines of the code just to define some editable fields. `Mininterface` is here to help.
+Writing a small and useful program might be a task that takes fifteen minutes. Adding a CLI to specify the parameters is not so much overhead. But building a simple GUI around it? HOURS! Hours spent on researching GUI libraries, wondering why the Python desktop app ecosystem lags so far behind the web world. All you need is a few input fields validated through a clickable window... You do not deserve to add hundred of lines of the code just to define some editable fields. *Mininterface* is here to help.
 
 The config variables needed by your program are kept in cozy dataclasses. Write less! The syntax of [tyro](https://github.com/brentyi/tyro) does not require any overhead (as its `argparse` alternatives do). You just annotate a class attribute, append a simple docstring and get a fully functional application:
 
 * Call it as `program.py --help` to display full help.
 * Use any flag in CLI: `program.py --my-flag`  causes `env.my_flag` be set to `True`.
-* The main benefit: Launch it without parameters as `program.py` to get a full working window with all the flags ready to be edited.
+* The main benefit: Launch it without parameters as `program.py` to get a fully working window with all the flags ready to be edited.
 * Running on a remote machine? Automatic regression to the text interface.
 * Or access your program via [web browser](http://127.0.0.1:8000/Interfaces/#webinterface-or-web).
 
@@ -146,27 +111,23 @@ pip install mininterface[all]  # GPLv3 and compatible
 
 ## Bundles
 
-There are various bundles. We mark the bundles with GPL3 dependencies.
+There are various bundles. We mark the least permissive licence in the bundle.
 
 | bundle | size | licence | description |
 | ------ | ---- | ----------- | ---- |
-| mininterface | 30 MB | LGPL | standard (GUI, TUI) |
-| mininterface | 36 MB | LGPL | standard (GUI, TUI) |
-| mininterface[web] | 36 MB | | including [WebInterface](Interfaces.md#webinterface-or-web) |
-| mininterface[img] | | | images |
-| mininterface[tui] | | | images |
-| mininterface[gui] | | GPL | images, combobox, calendar |
-| mininterface[ui] | 100 MB | GPL | full installation |
-| mininterface[all] | 100 MB | GPL | full installation, same as `ui`, reserved for future use (big dependencies, optional interfaces) |
+| mininterface | 1 MB | LGPL | minimal – only text dialogs |
+| mininterface[basic] | 25 MB | LGPL | CLI, GUI, TUI |
+| mininterface[web] | 40 MB | LGPL | including [WebInterface](Interfaces.md#webinterface-or-web) |
+| mininterface[img] | 40 MB | LGPL | images |
+| mininterface[tui] | 40 MB | LGPL | images |
+| mininterface[gui] | 70 MB | GPL | images, combobox, calendar |
+| mininterface[ui] | 90 MB | GPL | full installation |
+| mininterface[all] | 90 MB | GPL | full installation, same as `ui`, reserved for future use (big dependencies, optional interfaces) |
 
-## Minimal installation
+Apart from the minimal bundle (which lacks CLI and dataclass support), they have the same functionality, differring only in the user experience.
 
-Should you need just the CLI part and you are happy with basic text dialogs, use these commands instead:
-
-```bash
-pip install --no-dependencies mininterface
-pip install tyro typing_extensions pyyaml simple_term_menu
-```
+!!! tip
+  For automated testing (e.g., in CI environments), the `mininterface[basic]` bundle is sufficient.
 
 ## MacOS GUI
 
@@ -182,16 +143,18 @@ These projects have the code base reduced thanks to the mininterface:
 * **[deduplidog](https://github.com/CZ-NIC/deduplidog/)** – Find duplicates in a scattered directory structure
 * **[touch-timestamp](https://github.com/CZ-NIC/touch-timestamp/)** – A powerful dialog to change the files' timestamp
 
-# Hello world
+# Examples
+## Hello world
 
 Take a look at the following example.
+
 1. We define any Env class.
 2. Then, we initialize mininterface with [`run(Env)`][mininterface.run] – the missing fields will be prompter for
-3. Then, we use various dialog methods, like [`is_yes`][mininterface.Mininterface.is_yes], [`choice`][mininterface.Mininterface.choice] or [`form`][mininterface.Mininterface.form].
+3. Then, we use various dialog methods, like [`confirm`][mininterface.Mininterface.confirm], [`choice`][mininterface.Mininterface.select] or [`form`][mininterface.Mininterface.form].
 
 Below, you find the screenshots how the program looks in various environments ([graphic](Interfaces.md#guiinterface-or-tkinterface-or-gui) interface, [web](Interfaces.md#webinterface-or-web) interface...).
 
-```python3
+```python
 from dataclasses import dataclass
 from pathlib import Path
 from mininterface import run
@@ -212,11 +175,11 @@ if __name__ == "__main__":
       print("The file contents:", m.env.my_file.read_text())
 
       # You can use various dialog methods,
-      # like `is_yes` for bool
-      if m.is_yes("Do you want to continue?"):
+      # like `confirm` for bool
+      if m.confirm("Do you want to continue?"):
 
         # or `choice` for choosing a value
-        fruit = m.choice(("apple", "banana", "sirup"), "Choose a fruit")
+        fruit = m.select(("apple", "banana", "sirup"), "Choose a fruit")
 
         if fruit == "apple":
           # or `form` for an arbitrary values
@@ -251,7 +214,7 @@ Or via web browser `MININTERFACE_INTERFACE=web ./program.py`:
 You can always set Env via CLI or a config file:
 
 ```bash
-$ MININTERFACE_INTERFACE=gui ./program.py --help
+$ ./program.py --help
 usage: program.py [-h] [OPTIONS]
 
 ╭─ options ──────────────────────────────────────────────────────────────╮
@@ -263,3 +226,75 @@ usage: program.py [-h] [OPTIONS]
 │ --my-number INT        (default: 4)                                    │
 ╰────────────────────────────────────────────────────────────────────────╯
 ```
+
+## Goodbye argparse world
+
+You want to try out the Mininterface with your current [`ArgumentParser`](https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser)?
+
+You're using positional arguments, subparsers, types in the ArgumentParser... Mininterface will give you immediate benefit. Just wrap it inside the [`run`][mininterface.run] method.
+
+```python
+#!/usr/bin/env python3
+from argparse import ArgumentParser
+from datetime import time
+from pathlib import Path
+
+from mininterface import run
+
+parser = ArgumentParser()
+parser.add_argument("input_file", type=Path, help="Path to the input file.")
+parser.add_argument("--time", type=time, help="Given time")
+subparsers = parser.add_subparsers(dest="command", required=True)
+sub1 = subparsers.add_parser("build", help="Build something.")
+sub1.add_argument("--optimize", action="store_true", help="Enable optimizations.")
+
+# Old version
+# env = parser.parse_args()
+# env.input_file  # a Path object
+
+# New version
+m = run(parser)
+m.env.input_file  # a Path object
+
+# Live edit of the fields
+m.form()
+```
+
+Now, the help text looks much better. Try it in the terminal to see the colours.
+
+```
+$ ./program.py --help
+usage: program.py [-h] [OPTIONS] PATH
+
+╭─ positional arguments ──────────────────────────────────────────────────╮
+│ PATH                    Path to the input file. (required)              │
+╰─────────────────────────────────────────────────────────────────────────╯
+╭─ options ───────────────────────────────────────────────────────────────╮
+│ -h, --help              show this help message and exit                 │
+│ -v, --verbose           Verbosity level. Can be used twice to increase. │
+│ --time HH:MM[:SS[…]]    Given time (default: 00:00:00)                  │
+╰─────────────────────────────────────────────────────────────────────────╯
+╭─ build options ─────────────────────────────────────────────────────────╮
+│ --build.optimize, --build.no-optimize                                   │
+│                         Enable optimizations. (default: False)          │
+╰─────────────────────────────────────────────────────────────────────────╯
+```
+
+And what happens when you launch the program? First, *Mininterface* asks you to provide the missing required arguments. Note the button to raise a file picker dialog.
+
+![Positional fields](https://github.com/CZ-NIC/mininterface/blob/main/asset/argparse_required.avif?raw=True)
+
+Then, a `.form()` call will create a dialog with all the fields.
+
+![Whole form](https://github.com/CZ-NIC/mininterface/blob/main/asset/argparse_form.avif?raw=True)
+
+You will access the arguments through [`m.env`][mininterface.Mininterface.env]
+
+```python
+print(m.env.time)  # -> 14:21
+```
+
+If you're sure enough to start using *Mininterface*, convert the argparse into a dataclass. Then, the IDE will auto-complete the hints as you type.
+
+!!! warning
+    Be aware that in contrast to the argparse, we create default values. This does make sense for most values but might pose a confusion for ex. `parser.add_argument("--path", type=Path)` which becomes `Path('.')`, not `None`.