<commit_before>## PTYSH
PTYSH is an abbreviation of 'Python Teletype Shell'.<br>
It was made with reference to the 'zebra vtysh'.<br>
Vtysh is an integrated shell for Quagga routing software.<br>
<br>
Ptysh is not the only route shell, the shell is customizable, so you can normally use.<br>
It made it possible to add commands to the module for availability.<br>


## Note
You can install ptysh through the pip.<br>
However, you must manually install some libraries.<br>
I'll update the library list soon.<br>


## Usage
### Start shell
When you run the 'ptysh_main.py', the shell begins.<br>
You can use the commands summarized below.<br>
During PTYSH to use commands such as ctrl-c and ctrl-z does not work.<br>


### Add custom module
To add a module, you will create a file with reference to the sample code in the "modules" directory.<br>
You can create additional logic inherit the class ptysh_module.<br>


## Command
### disable mode
1. enable
	* Enter the control shell
	* It required password. (default password is <PASSWORD>)
2. exit
	* exit the shell.
3. list
	* show command list.
4. st
	* start-shell (default shell is bash)
	* It is hidden command.
	* It required password and it is same to enable password.


### enable mode
1. diable
	* exit the enable mode
2. exit
	* exit the shell.
3. list
	* show command list.
4. configure terminal
	* It is control menu for other modules.

### configure terminal mode
1. exit
	* exit the shell.
2. list
	* show command list.


## Idea or Issue
If you have an idea or issue, feel free to open an issue or make pull request.<commit_msg>Fix the readme file.<commit_after>## PTYSH
PTYSH is an abbreviation of 'Python Teletype Shell'.<br>
It was made with reference to the 'zebra vtysh'.
Vtysh is an integrated shell for Quagga routing software.<br>
Ptysh is not the only route shell, the shell is customizable, so you can general purpose.<br>


## Notice
You can install PTYSH through the pip.<br>
However, you must manually install some libraries.<br>
I'll update the library list soon.<br>


## Usage
### Start shell
When you run the 'ptysh_main.py', the shell begins.<br>
You can use the commands summarized below.<br>
You can't use the command (suchs as Ctrl-Z or Ctrl-C) to use during PTYSH.<br>


### Add custom module
To add a module, you will create a file with reference to the sample code in the "modules" directory.<br>
You can create additional logic inherit the class 'ptysh_module'.<br>


## Command
### In 'disable mode'
1. enable
	* Enter the control shell
	* It is required password. (default password is <PASSWORD>)
2. exit
	* exit the shell.
3. list
	* show command list.
4. st
	* start-shell (default shell is bash)
	* It is hidden command.
	* It is required password and it is same to enable password.


### In 'enable mode'
1. diable
	* exit the enable mode
2. exit
	* exit the shell.
3. list
	* show command list.
4. configure terminal
	* It is control menu for other modules.


### In 'configure terminal mode'
1. exit
	* exit the shell.
2. list
	* show command list.
3. [Modules list]
	* show modules name list


## Plan
1. Fix the pip install configuration problem(libraries).
2. Internal logic refactoring for scalability.
3. Improved stability in various environments.
4. Create wiki page and fix the readme file.



## Idea or Issue
If you have an idea or issue, feel free to open an issue or make pull request.
{'fraction_non_alphanumeric': 0.0816386678455644, 'fraction_numerical': 0.0073681108163866785, 'mean_word_length': 3.7468531468531467, 'pattern_counts': {'":': 0, '<': 30, '<?xml version=': 0, '>': 30, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1576657', 'n_tokens_mistral': 1032, 'n_tokens_neox': 995, 'n_words': 527}