# 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
```
### 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/).
Raw data
{
"_id": null,
"home_page": "https://github.com/mauricelambert/CustomShell",
"name": "CustomShell",
"maintainer": "Maurice Lambert",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "mauricelambert434@gmail.com",
"keywords": "Shell,Command,Terminal",
"author": "Maurice Lambert",
"author_email": "mauricelambert434@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a0/80/4600bbf8b99033f2682e553bf6fc1d982115478bcd006641f18657a32261/CustomShell-0.2.1.tar.gz",
"platform": "Windows",
"description": "![CustomShell logo](https://mauricelambert.github.io/info/python/code/CustomShell_small.png \"CustomShell logo\")\n\n# CustomShell\n\n## Description\n\nThis package implements a Customizable Shell.\n\n## Requirements\n\nThis package require:\n - python3\n - python3 Standard Library\n\n## Installation\n\n```bash\npip install CustomShell\n```\n\n## Usages\n\n### Command lines\n\n```bash\npython3 -m CustomShell\npython3 CustomShell.pyz\nShell\n```\n\n\n\n\n### Python3\n\n```python\nfrom CustomShell import main\nmain()\n\nfrom CustomShell import Shell\nshell = Shell()\nshell.cmdloop()\n```\n\n## Configuration\n\n### Default\n\nDefault configuration file path:\n - **Windows**: `C:\\\\Users\\\\<username>\\\\Shell.ini`\n - **Linux**: `~/Shell.ini`\n\n```ini\n[DISPLAY]\nprompt = {E} {color}{green}{U}{color}{reset}@{color}{green}{N}{color}{reset}:{color}{green}{P}{color}{reset}$\nstart_intro = echo {a}\nend_intro = echo {a}\nintro = {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}\nstart_quit = echo {a}\nend_quit = echo {a}\nquit = {n}{color}{bgwhite}{color}{underline}{red}*** {D} {T} - Bye {U} ! ***{color}{reset}{n}\n\n[ALIAS]\npyc = python -c \npym = python -m \n\n\n```\n\n### Variables for configuration\n\n```\n{U} = username,\n{N} = hostname,\n{P} = current path,\n{p} = directory,\n{T} = time,\n{D} = date,\n{o} = operatoring system (win32, linux, ...),\n{S} = system (Windows, Linux, ...),\n{s} = system (nt, posix...),\n{n} = new line (\\n),\n{a} = ASCII character 7 (sound),\n{e} = python executable,\n{v} = python version,\n{V} = system version,\n{c} = CustomShell version,\n{E} = status of the last command execution,\n```\n\n### Unix Color\n\n```\n{black} {red} {green} {other} {blue} {purple} {cyan} {white} {bgblack} {bgred} {bggreen} {bgother} {bgblue} {bgpurple} {bgcyan} {bgwhite} {texte} {bold} {underline} {reset} {color}\n```\n\n - To make a white background you can use: `{color}{bgwhite}`.\n - To make a blue bold text you can use: `{color}{bold}{blue}`.\n - To make a red undernline text you can use: `{color}{underline}{red}`.\n - To reset color: `{color}{reset}`.\n\n## Links\n\n - [Github Page](https://github.com/mauricelambert/CustomShell)\n - [Pypi](https://pypi.org/project/CustomShell/)\n - [Documentation](https://mauricelambert.github.io/info/python/code/CustomShell.html)\n - [Executable](https://mauricelambert.github.io/info/python/code/CustomShell.pyz)\n\n## Licence\n\nLicensed under the [GPL, version 3](https://www.gnu.org/licenses/).",
"bugtrack_url": null,
"license": "GPL-3.0 License",
"summary": "This file implements a customizable shell.",
"version": "0.2.1",
"split_keywords": [
"shell",
"command",
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "495f9b5811582edf450f1c7e7405ac5e",
"sha256": "38fc43da18c845d3a4c402e4e7f3962b231268970b42cc049ce33a5bb0188248"
},
"downloads": -1,
"filename": "CustomShell-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "495f9b5811582edf450f1c7e7405ac5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 21074,
"upload_time": "2023-01-02T13:22:03",
"upload_time_iso_8601": "2023-01-02T13:22:03.304591Z",
"url": "https://files.pythonhosted.org/packages/a0/80/4600bbf8b99033f2682e553bf6fc1d982115478bcd006641f18657a32261/CustomShell-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-02 13:22:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mauricelambert",
"github_project": "CustomShell",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "customshell"
}
JSON
