Metadata-Version: 2.1
Name: CustomShell
Version: 0.2.1
Summary: This file implements a customizable shell.
Home-page: https://github.com/mauricelambert/CustomShell
Author: Maurice Lambert
Author-email: mauricelambert434@gmail.com
Maintainer: Maurice Lambert
Maintainer-email: mauricelambert434@gmail.com
License: GPL-3.0 License
Project-URL: Documentation, https://mauricelambert.github.io/info/python/code/CustomShell.html
Project-URL: Executable, https://mauricelambert.github.io/info/python/code/CustomShell.pyz
Description: ![CustomShell logo](https://mauricelambert.github.io/info/python/code/CustomShell_small.png "CustomShell logo")
        
        # CustomShell
        
        ## Description
        
        This package implements a Customizable Shell.
        
        ## Requirements
        
        This package require:
         - python3
         - python3 Standard Library
        
        ## Installation
        
        ```bash
        pip install CustomShell
        ```
        
        ## Usages
        
        ### Command lines
        
        ```bash
        python3 -m CustomShell
        python3 CustomShell.pyz
        Shell
        ```
        
        ![Demonstration Linux](https://mauricelambert.github.io/info/python/code/CustomShell_linux.PNG)
        ![Demonstration Windows](https://mauricelambert.github.io/info/python/code/CustomShell_windows.PNG)
        
        ### Python3
        
        ```python
        from CustomShell import main
        main()
        
        from CustomShell import Shell
        shell = Shell()
        shell.cmdloop()
        ```
        
        ## Configuration
        
        ### Default
        
        Default configuration file path:
         - **Windows**: `C:\\Users\\<username>\\Shell.ini`
         - **Linux**: `~/Shell.ini`
        
        ```ini
        [DISPLAY]
        prompt = {E} {color}{green}{U}{color}{reset}@{color}{green}{N}{color}{reset}:{color}{green}{P}{color}{reset}$
        start_intro = echo {a}
        end_intro = echo {a}
        intro = {S}     {V}     [{s}, {o}] {n}Python    {v}         [{e}]{n}CustomShell     {c}         [GPL-3.0]{n}{n}{color}{bgwhite}{color}{bold}{blue}*** {D} {T} - Welcome in CustomShell {U} ! ***{color}{reset}{n}
        start_quit = echo {a}
        end_quit = echo {a}
        quit = {n}{color}{bgwhite}{color}{underline}{red}*** {D} {T} - Bye {U} ! ***{color}{reset}{n}
        
        [ALIAS]
        pyc  = python -c 
        pym  = python -m 
        
        
        ```
        
        ### Variables for configuration
        
        ```
        {U} = username,
        {N} = hostname,
        {P} = current path,
        {p} = directory,
        {T} = time,
        {D} = date,
        {o} = operatoring system (win32, linux, ...),
        {S} = system (Windows, Linux, ...),
        {s} = system (nt, posix...),
        {n} = new line (\n),
        {a} = ASCII character 7 (sound),
        {e} = python executable,
        {v} = python version,
        {V} = system version,
        {c} = CustomShell version,
        {E} = status of the last command execution,
        ```
        
        ### Unix Color
        
        ```
        {black} {red} {green} {other} {blue} {purple} {cyan} {white} {bgblack} {bgred} {bggreen} {bgother} {bgblue} {bgpurple} {bgcyan} {bgwhite} {texte} {bold} {underline} {reset} {color}
        ```
        
         - To make a white background you can use: `{color}{bgwhite}`.
         - To make a blue bold text you can use: `{color}{bold}{blue}`.
         - To make a red undernline text you can use: `{color}{underline}{red}`.
         - To reset color: `{color}{reset}`.
        
        ## Links
        
         - [Github Page](https://github.com/mauricelambert/CustomShell)
         - [Pypi](https://pypi.org/project/CustomShell/)
         - [Documentation](https://mauricelambert.github.io/info/python/code/CustomShell.html)
         - [Executable](https://mauricelambert.github.io/info/python/code/CustomShell.pyz)
        
        ## Licence
        
        Licensed under the [GPL, version 3](https://www.gnu.org/licenses/).
        
Keywords: Shell,Command,Terminal
Platform: Windows
Platform: Linux
Platform: MacOS
Classifier: Programming Language :: Python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Requires-Python: >=3.6
Description-Content-Type: text/markdown
