Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyan001/pyconsoleiotools
A convenience tool for console input & output
https://github.com/kyan001/pyconsoleiotools
console pypi python3
Last synced: about 2 months ago
JSON representation
A convenience tool for console input & output
- Host: GitHub
- URL: https://github.com/kyan001/pyconsoleiotools
- Owner: kyan001
- License: mit
- Created: 2016-10-10T05:57:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T04:50:16.000Z (5 months ago)
- Last Synced: 2024-08-14T05:52:24.352Z (5 months ago)
- Topics: console, pypi, python3
- Language: Python
- Homepage:
- Size: 63.5 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyConsoleIOTools
[](https://github.com/kyan001/PyConsoleIOTools/blob/master/LICENSE)
## Installation
```sh
pip install consoleiotools # install
pip install --upgrade consoleiotools # update
python -m consoleiotools # examples
```
## Get Started
```python
import consoleiotools as cit
print(cit.__version__)
```
## Prints on Screen
```python
>>> cit.start()
# blank line
>>> cit.title("Session Name")
+--------------+
| SESSION NAME |
+--------------+
>>> cit.echo("Hello World")
| Hello World
>>> cit.echo("Hello World", pre="say", bar="!")
! (Say) Hello World
>>> cit.echo("Hello World", indent=1) # indent level, default is 0.
| |-- Hello World
>>> cit.echo("Hello World", indent=-1) # level < 0 means the last line of this indent.
| `-- Hello World
>>> cit.echo("Hello World", indent=3) # 3 level of indent.
| | | |-- Hello World
>>> cit.ask("Hello World")
| (?) Hello World
>>> cit.info("Hello World")
| (Info) Hello World
>>> cit.warn("Hello World")
| (Warning) Hello World
>>> cit.err("Hello World")
| (Error) Hello World
>>> cit.mute("Hello World")
| Hello World # muted by dim
>>> cit.print("[yellow]Hello World[/]") # print with styles
Hello World # yellow
>>> cit.print(cit.escape("[yellow]Hello World[/]")) # escape `[` -> `\[` if not escaped. escape `\` -> `\\` if not used as escape char.
[yellow]Hello World[/]
>>> cit.markdown("# Header") # print markdown
+--------------+
| Header |
+--------------+
>>> cit.rule() # print horizontal rule
----------------------------------------
>>> cit.rule("Title", style="blue", align="center") # print horizontal rule with Title. align = center|left|right
---------------- Title ----------------
>>> cit.panel("Panel", title="Panel Title", subtitle="Panel Subtitle") # print text in a panel
+---------- Panel Title ----------+
| Panel | # full width
+-------- Panel Subtitle ---------+
>>> cit.panel("Panel", title="Panel Title", subtitle="Panel Subtitle", expand=False, style="blue") # fit panel to text
+- Panel Title -+ # blue
| Panel |
+- Panel Subtit-+
>>> cit.end()
`
>>> cit.br()
# blank line
>>> cit.br(2)
# blank line
# blank line
>>> for var in cit.track(iterables, "Progress"): pass
| : Progress ---------------------=================== 52% 0:00:52 - 52/100
>>> cit.__ascii__ = True # use ascii chars only.
```
## Get User Input
```python
>>> cit.get_input() # Get user input from stdin
> Hello World
'Hello World'
>>> cit.get_input("Question?") # With a question
| (?) Question?
> Yes
'Yes'
>>> cit.get_input(prompt="Answer:") # With a customized prompt.
Answer: Apple
'Apple'
>>> cit.get_input("Continue?", default="yes") # With a default answer.
| (?) Continue?
> (yes) # Entered nothing
'yes'
>>> cit.get_input(strip=False) # Do not remove leading and trailing whitespaces from user input.
> # Whitespaces
' '
>>> cit.get_choice(["Apple", "Google"]) # Enter number to select.
| 1) Apple
| 2) Google
> 2
'Google'
>>> cit.get_choice(["Apple", "Google"]) # Enter string is ok too.
| 1) Apple
| 2) Google
> Google
'Google'
>>> cit.get_choice(["Apple", "Google"], exitable=True) # Add a choice of exit in menu.
| 1) Apple
| 2) Google
| 0) ** EXIT **
> 0
None
>>> cit.get_choices(["Apple", "Google"]) # Multiple Selection
| 1) [ ] Apple
| 2) [ ] Google
> 1 # Enter number to check or uncheck selections
| 1) [+] Apple
| 2) [ ] Google
| 0) ** DONE **
> Google # Enter string is ok too.
| 1) [+] Apple
| 2) [+] Google
| 0) ** DONE **
> 0 # Enter 0 when done.
['Apple', 'Google'] # return [] is no selections.
>>> cit.get_choices(["Apple", "Google"], allable=True) # Add a choice of select all in menu.
| a) ** ALL **
| 1) [ ] Apple
| 2) [ ] Google
> a # Enter `a` to check all. If `a` is in choices, enter `all`.
| a) ** ALL **
| 1) [+] Apple
| 2) [+] Google
| 0) ** DONE **
> 0
['Apple', 'Google']
>>> cit.get_choices(["Apple", "Google"], exitable=True) # Add a choice of exit in menu.
| 1) [ ] Apple
| 2) [ ] Google
| 0) ** EXIT **
> 0
[] # Empty list returned.
```
## File IO
```python
>>> cit.read_file("/path/to/file")
'Hello World'
>>> cit.read_file("/path/to/file", with_encoding=True)
('Hello World', 'utf-8')
>>> cit.write_file("/path/to/file", "Hello World") # Append content to file.
11 # writed bytes
>>> cit.write_file("/path/to/file", "Hello World", overwrite=True) # Overwrite if file exists.
11 # writed bytes
```
## Controls
```python
>>> cit.pause()
| Press [Enter] to Continue...
>>> cit.bye()
# exit
>>> cit.bye(0)
# exit with code 0
>>> cit.bye("Seeya")
Seeya
# exit
```
## Decorators
```python
@cit.as_session("Hello") # String as the Title of the session.
def my_func():
cit.echo("World")
>>> my_func()
+---------+
| HELLO() |
+---------+
| World
`
@cit.as_session # Use function name as the Title of the session.
def underscore_orCamel():
pass
>>> underscore_orCamel()
+-----------------------+
| UNDERSCORE OR CAMEL() |
+-----------------------+
`
@cit.deprecated_by(new_func): # A function object as argument.
def old_func(...):
pass # code here won't be actually executed.
>>> old_func(...)
Function `old_func` is deprecated, now calling `new_func` instead. # Warning printed to stderr.
# new_func(...) is called
```