linux test passed

Author: thautwarm

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "yapf"
+}

README.md

@@ -4,10 +4,36 @@ RTPY
 
 RTPY is an intuitive and effective CLI framework which is scalable and practical.
 
-The most common use case might be an alternative of Python's `argparser`,
-however it's so easy for RTPY user to extend shell commands.(**For example, I just implemented
+The most common use case might be an alternative of Python's `argparser`.
+
+however it's natural for RTPY users to extend shell commands.(**For example, I just implemented
 `autojump` in 2 hours and a half. I spent so long for I'm so sleepy in the mid-night :)**)
 
+Install & Run Rush
+--------------------
+
+```
+pip install -U Redy rbnf rtpy
+```
+
+Additionally, **RUSH** is a terminal implemented by `rtpy` which currently supports some *NIX commands like `cd`, `ls`, `echo`, 
+and some interesting plugins written in pure **rtpy** api like `autojump`. After installing `rtpy`, you can try **RUSH** 
+by typing `rush`.
+
+```shell
+
+[ruiko@localhost rtpy]$ rush
+wd:  /home/ruiko/rtpy
+rush> ls --help
+ls
+- suffix(positional or keyword arg) = None :  a filename suffix to apply filtering. default to perform no filtering.
+- r(keyword only) = False                  : is recursive
+
+wd:  /home/ruiko/rtpy
+
+```
+
+
 As New Argument Parser
 ----------------------------------
 

README.rst

@@ -5,9 +5,36 @@ RTPY is an intuitive and effective CLI framework which is scalable and
 practical.
 
 The most common use case might be an alternative of Python's
-``argparser``, however it's so easy for RTPY user to extend shell
-commands.(\ **For example, I just implemented ``autojump`` in 2 hours
-and a half. I spent so long for I'm so sleepy in the mid-night :)**)
+``argparser``.
+
+however it's natural for RTPY users to extend shell commands.(\ **For
+example, I just implemented ``autojump`` in 2 hours and a half. I spent
+so long for I'm so sleepy in the mid-night :)**)
+
+Install & Run Rush
+------------------
+
+::
+
+    pip install -U Redy rbnf rtpy
+
+Additionally, **RUSH** is a terminal implemented by ``rtpy`` which
+currently supports some \*NIX commands like ``cd``, ``ls``, ``echo``,
+and some interesting plugins written in pure **rtpy** api like
+``autojump``. After installing ``rtpy``, you can try **RUSH** by typing
+``rush``.
+
+.. code:: shell
+
+
+    [ruiko@localhost rtpy]$ rush
+    wd:  /home/ruiko/rtpy
+    rush> ls --help
+    ls
+    - suffix(positional or keyword arg) = None :  a filename suffix to apply filtering. default to perform no filtering.
+    - r(keyword only) = False                  : is recursive
+
+    wd:  /home/ruiko/rtpy
 
 As New Argument Parser
 ----------------------
@@ -105,7 +132,7 @@ expression.
 
 The implementations are so trivial:
 
-See ``rtpy.terminal.path``:
+See ``rtpy._terminal.path``:
 
 .. code:: python
 
@@ -145,6 +172,6 @@ Welcome to
 -  Make interesting and powerful commands to ``rbnf/_terminal``.
 
 .. |terminal_demo| image:: https://github.com/thautwarm/rtpy/blob/master/terminal_demo.jpg
-    :target: https://github.com/thautwarm/rtpy/blob/master/terminal_demo.jpg
+   :target: https://github.com/thautwarm/rtpy/blob/master/terminal_demo.jpg
 .. |autojump| image:: https://github.com/thautwarm/rtpy/blob/master/auto_jump.jpg
-    :target: https://github.com/thautwarm/rtpy/blob/master/auto_jump.jpg
+   :target: https://github.com/thautwarm/rtpy/blob/master/auto_jump.jpg

next_version

@@ -1 +1 @@
-0.1.5
+0.1.7

rtpy/terminal.py

@@ -8,8 +8,14 @@
     rtpy_config_dir.mkdir()
     src_dir = Path(__file__).parent().into('_terminal')
     src_dir.move_to(rtpy_config_dir)
-    os.rename(str(rtpy_config_dir.into('_terminal')), str(rtpy_config_dir.into('rtpy_terminal')))
+    os.rename(
+        str(rtpy_config_dir.into('_terminal')),
+        str(rtpy_config_dir.into('rtpy_terminal')))
 
 sys.path.append(str(rtpy_config_dir))
 
 from rtpy_terminal.path import talking
+
+
+def main():
+    talking.listen()

setup.py

@@ -9,28 +9,29 @@
     version = Version(f.read().strip())
 
 # @formatter:off
-setup(name='rtpy',
-      version=str(version),
-      keywords='CLI solution',
-      description="effective and intuitive CLI framework",
-      long_description=readme,
-      license='MIT',
-      url='https://github.com/thautwarm/rtpy',
-      author='thautwarm',
-      author_email='[email protected]',
-      include_package_data=True,
-      install_requires=['Redy', 'rbnf', 'readline', 'linq-t'],
-      packages=['rtpy.cmd', 'rtpy.weapon', 'rtpy._terminal'],
-      platforms='any',
-      classifiers=[
-          'Programming Language :: Python :: 3.6',
-          'Programming Language :: Python :: 3.7',
-          'Programming Language :: Python :: Implementation :: CPython'],
-      zip_safe=False
-      )
+setup(
+    name='rtpy',
+    version=str(version),
+    keywords='CLI solution',
+    description="effective and intuitive CLI framework",
+    long_description=readme,
+    license='MIT',
+    url='https://github.com/thautwarm/rtpy',
+    author='thautwarm',
+    author_email='[email protected]',
+    include_package_data=True,
+    install_requires=['Redy', 'rbnf', 'readline', 'linq-t'],
+    packages=['rtpy.cmd', 'rtpy.weapon', 'rtpy._terminal', 'rtpy'],
+    entry_points={'console_scripts': ['rush=rtpy.terminal:main']},
+    platforms='any',
+    classifiers=[
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: Implementation :: CPython'
+    ],
+    zip_safe=False)
 # @formatter:on
 
-
 version.increment(version_number_idx=2, increment=1)
 if version[2] is 42:
     version.increment(version_number_idx=1, increment=1)