Merge branch 'master' of https://github.com/petereon/beaupy into dependabot/pip/urllib3-2.0.7

Author: petereon

APIDOC.md

@@ -51,7 +51,7 @@ Creates a spinner which can be used to provide some user feedback during long pr
 - `refresh_per_second` _float, optional_ - Number of refreshes the spinner will do a second, this will affect
   the fluidity of the "animation". Defaults to 10.
 - `transient` _bool, optional_ - If the spinner will disappear after it's done, otherwise not. Defaults to True.
-  
+
 
 **Raises**:
 
@@ -146,14 +146,14 @@ Function that prompts the user for written input
   the error will be reported onto the console. Defaults to True.
 - `raise_type_conversion_fail` _bool, optional_ - If True, invalid inputs will raise `rich.internals.ConversionError`, else
   the error will be reported onto the console. Defaults to True.
-  
+
 
 **Raises**:
 
 - `ValidationError` - Raised if validation with provided validator fails
 - `ConversionError` - Raised if the value cannot be converted to provided type
 - `KeyboardInterrupt` - Raised when keyboard interrupt is encountered and Config.raise_on_interrupt is True
-  
+
 
 **Returns**:
 
@@ -188,13 +188,13 @@ A prompt that allows selecting one option from a list of options
 - `return_index` _bool, optional_ - If `True`, `select` will return the index of selected element in options. Defaults to `False`.
 - `strict` _bool, optional_ - If empty `options` is provided and strict is `False`, None will be returned,
   if it's `True`, `ValueError` will be thrown. Defaults to False.
-  
+
 
 **Raises**:
 
-- `ValueError` - Thrown if no `options` are povided and strict is `True`
+- `ValueError` - Thrown if no `options` are provided and strict is `True`
 - `KeyboardInterrupt` - Raised when keyboard interrupt is encountered and Config.raise_on_interrupt is True
-  
+
 
 **Returns**:
 
@@ -238,12 +238,12 @@ A prompt that allows selecting multiple options from a list of options
   of ticked elements in options. Defaults to `False`.
 - `strict` _bool, optional_ - If empty `options` is provided and strict is `False`, None will be returned,
   if it's `True`, `ValueError` will be thrown. Defaults to False.
-  
+
 
 **Raises**:
 
 - `KeyboardInterrupt` - Raised when keyboard interrupt is encountered and Config.raise_on_interrupt is True
-  
+
 
 **Returns**:
 
@@ -278,14 +278,13 @@ A prompt that asks a question and offers two responses
 - `cursor` _str, optional_ - What character(s) to use as a cursor. Defaults to '> '.
 - `cursor_style` _str, optional_ - Rich friendly style for the cursor. Defaults to 'pink1'.
 - `char_prompt` _bool, optional_ - Print [Y/n] after the question. Defaults to True.
-  
+
 
 **Raises**:
 
 - `KeyboardInterrupt` - Raised when keyboard interrupt is encountered and Config.raise_on_interrupt is True
-  
+
 
 **Returns**:
 
   Optional[bool]
-

README.md

@@ -1,7 +1,5 @@
 # BeauPy
 
-## :warning: __Beaupy is not accepting pull-requests at the moment as the code-base is getting migrated towards [`questo`](https://github.com/petereon/questo) shortly__.
-
 ![beaupy](https://user-images.githubusercontent.com/47027005/185082011-cb588f57-d38f-42d8-8312-3981ae1bc479.png)
 
 > A Python library of interactive CLI elements you have been looking for
@@ -34,7 +32,7 @@ BeauPy stands on the shoulders of giants. It is based on another library with wh
 | [`confirm`](https://petereon.github.io/beaupy/api/#confirm)                      | Prompt with a question and yes/no options                                                  |
 | [`prompt`](https://petereon.github.io/beaupy/api/#prompt)                        | Prompt that takes free input with optional validation, type conversion and input hiding |
 
-TUI elements shown in the above gif are the result of the follwing code:
+TUI elements shown in the above gif are the result of the following code:
 
 ```python
 import time
@@ -57,8 +55,8 @@ if confirm("Will you take the ring to Mordor?"):
     # Choose one item from a list
     name = select(names, cursor="🢧", cursor_style="cyan")
     console.print(f"Alámenë, {name}")
-    
-    
+
+
     item_options = [
         "The One Ring",
         "Dagger",
@@ -68,44 +66,44 @@ if confirm("Will you take the ring to Mordor?"):
     console.print("What do you bring with you?")
     # Choose multiple options from a list
     items = select_multiple(item_options, tick_character='🎒', ticked_indices=[0], maximal_count=3)
-    
+
     potato_count = 0
     if "Po-tae-toes" in items:
         # Prompt with type conversion and validation
         potato_count = prompt('How many potatoes?', target_type=int, validator=lambda count: count > 0)
-    
+
     # Spinner to show while doing some work
     spinner = Spinner(DOTS, "Packing things...")
     spinner.start()
-    
+
     time.sleep(2)
-    
+
     spinner.stop()
     # Get input without showing it being typed
     if "friend" == prompt("Speak, [blue bold underline]friend[/blue bold underline], and enter", secure=True).lower():
-        
+
         # Custom spinner animation
         spinner_animation = ['▉▉', '▌▐', '  ', '▌▐', '▉▉']
         spinner = Spinner(spinner_animation, "Opening the Door of Durin...")
         spinner.start()
-        
+
         time.sleep(2)
-        
+
         spinner.stop()
     else:
         spinner_animation = ['🐙🌊    ⚔️ ', '🐙 🌊   ⚔️ ', '🐙  🌊  ⚔️ ', '🐙   🌊 ⚔️ ', '🐙    🌊⚔️ ']
         spinner = Spinner(spinner_animation, "Getting attacked by an octopus...")
         spinner.start()
-        
+
         time.sleep(2)
-        
+
         spinner.stop()
 
     if 'The One Ring' in items:
         console.print("[green]You throw The One Ring to a lava from an eagle![/green]")
     else:
         console.print("[red]You forgot the ring and brought Middle-Earth to its knees![/red]")
-    console.print(f"And you brought {potato_count} taters!")      
+    console.print(f"And you brought {potato_count} taters!")
 ```
 
 For more information refer to [more examples](https://petereon.github.io/beaupy/examples/) or definitive, but much less exciting [API documentation](https://petereon.github.io/beaupy/api/)