| Name | xTerm JSON |
| Version |
1.6.3
JSON |
| download |
| home_page | https://github.com/xTerm/xTerm |
| Summary | Professional modding to the terminal and changing the font of string texts |
| upload_time | 2024-11-02 18:40:45 |
| maintainer | None |
| docs_url | None |
| author | Mmdrza |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="https://raw.githubusercontent.com/PyxTerm/xTerm/main/.github/workflows/Typographic.png" title="xterm Python Package" alt="python Package xTerm" width="auto" height="auto">
# xTerm
## Install
Windows Install with `pip`
```bash
pip install xTerm
```
Linux Install with `pip3`
```bash
pip3 install xTerm
```
Upgrade xterm Python Package : `pip install --upgrade xTerm` or `pip3 install --upgrade xTerm`
```python
from xTerm import Maths
# class shortcut
maths = Maths(font_type="Sans_Serif")
# or
maths = Maths(font_type="Sans_Serif_bold")
# or
maths = Maths(font_type="Sans_Serif_italic")
# or
maths = Maths(font_type="Sans_Serif_bold_italic")
# or
maths = Maths(font_type="Mathematical_bold")
# or
maths = Maths(font_type="Mathematical_italic")
# or
maths = Maths(font_type="Mathematical_Fraktur")
# or
maths = Maths(font_type="Mathematical_bold_Fraktur")
# or
maths = Maths(font_type="Mathematical_double_struck")
# or
maths = Maths(font_type="Mathematical_monospace")
# converet string model to any unicode font ,
converted_text = maths.Convert("Hello World")
print(converted_text)
```
---
## Alpha Mode (Convert Font String)
Convert String Text To Unicode Font Display
```python
from xTerm import Alpha
# shortcut class
alpha = Alpha.Maths(font_type="Sans_Serif_bold_italic")
# text string for convert
converted_text = alpha.Convert("Hello World")
# Print Output
print(converted_text)
# Hello World
```
## Table Mode (Create Table Data on Terminal)
Draw Table Data On Any Terminal
```python
from xTerm import Table
table = Table([["User01", "34"], ["User02", "56"]], ["User", "ID"], "simple_grid")
print(table)
```
Output:
```
┌────────┬──────┐
│ User │ ID │
├────────┼──────┤
│ User01 │ 34 │
├────────┼──────┤
│ User02 │ 56 │
└────────┴──────┘
```
---
```python
from xTerm import Table
# Create Table Data List
table = Table([
["File 01", 233345],
["File 02", 545660],
["File 03", 100057],
["File 04", 438103]],
["File Name", "Download"]
, "simple_grid")
# Output:
# ┌─────────────┬────────────┐
# │ File Name │ Download │
# ├─────────────┼────────────┤
# │ File 01 │ 233345 │
# ├─────────────┼────────────┤
# │ File 02 │ 545660 │
# ├─────────────┼────────────┤
# │ File 03 │ 100057 │
# ├─────────────┼────────────┤
# │ File 04 │ 438103 │
# └─────────────┴────────────┘
```
---
## Table Funcation
- `table_data`: Any,
- `headers`: tuple = (),
- `tablefmt`: str = "simple",
- `floatfmt`: str = _DEFAULT_FLOATFMT,
- `intfmt`: str = _DEFAULT_INTFMT,
- `numalign`: str = _DEFAULT_ALIGN,
- `stralign`: str = _DEFAULT_ALIGN,
- `missingval`: str = _DEFAULT_MISSINGVAL,
- `showindex`: str = "default",
- `disable_numparse`: bool = False,
- `colglobalalign`: Any = None,
- `colalign`: Any = None,
- `maxcolwidths`: Any = None,
- `headersglobalalign`: Any = None,
- `headersalign`: Any = None,
- `rowalign`: Any = None,
- `maxheadercolwidths`: Any = None) -> JupyterHTMLStr | LiteralString | str
---
### Table formatting
There is more than one way to format a table in plain text. The third optional argument named tablefmt defines how the
table is formatted.
Supported table formats are:
| Parameter | Type | Value | Parameter | Type | Value |
|:-------------|:--------:|:------------------|--------------:|:--------:|:------------------|
| **tablefmt** | _string_ | `plain` | **tablefmt** | _string_ | `orgtbl` |
| **tablefmt** | _string_ | `simple` | **tablefmt** | _string_ | `asciidoc` |
| **tablefmt** | _string_ | `github` | **tablefmt** | _string_ | `jira` |
| **tablefmt** | _string_ | `grid` | **tablefmt** | _string_ | `presto` |
| **tablefmt** | _string_ | `simple_grid` | **tablefmt** | _string_ | `pretty` |
| **tablefmt** | _string_ | `rounded_grid` | **tablefmt** | _string_ | `psql` |
| **tablefmt** | _string_ | `heavy_grid` | **tablefmt** | _string_ | `rst` |
| **tablefmt** | _string_ | `mixed_grid` | **tablefmt** | _string_ | `mediawiki` |
| **tablefmt** | _string_ | `double_grid` | **tablefmt** | _string_ | `moinmoin` |
| **tablefmt** | _string_ | `fancy_grid` | **tablefmt** | _string_ | `youtrack` |
| **tablefmt** | _string_ | `outline` | **tablefmt** | _string_ | `html` |
| **tablefmt** | _string_ | `simple_outline` | **tablefmt** | _string_ | `unsafehtml` |
| **tablefmt** | _string_ | `rounded_outline` | **tablefmt** | _string_ | `latex` |
| **tablefmt** | _string_ | `heavy_outline` | **tablefmt** | _string_ | `latex_raw` |
| **tablefmt** | _string_ | `mixed_outline` | **tablefmt** | _string_ | `latex_booktabs` |
| **tablefmt** | _string_ | `double_outline` | **tablefmt** | _string_ | `latex_longtable` |
| **tablefmt** | _string_ | `fancy_outline` | **tablefmt** | _string_ | `textile` |
| **tablefmt** | _string_ | `pipe` | **tablefmt** | _string_ | `tsv` |
More details : [table](https://xterm.readthedocs.io/en/latest/table/ 'xTerm Table Terminal') | [Notebook Example](https://deepnote.com/app/vector3/xTerm-5a0d16cf-d30e-4373-8564-4b5f7b2d0ed3)
Raw data
{
"_id": null,
"home_page": "https://github.com/xTerm/xTerm",
"name": "xTerm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Mmdrza",
"author_email": "Pymmdrza@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/20/33/7631e8a0ad008995361a2abb8d21dcd3221fa2977dd1db2b142a8dc6dd10/xterm-1.6.3.tar.gz",
"platform": null,
"description": "<img src=\"https://raw.githubusercontent.com/PyxTerm/xTerm/main/.github/workflows/Typographic.png\" title=\"xterm Python Package\" alt=\"python Package xTerm\" width=\"auto\" height=\"auto\"> \n\n# xTerm\n## Install\n\nWindows Install with `pip`\n\n```bash\npip install xTerm\n```\n\nLinux Install with `pip3`\n\n```bash\npip3 install xTerm\n```\n\nUpgrade xterm Python Package : `pip install --upgrade xTerm` or `pip3 install --upgrade xTerm`\n\n```python\nfrom xTerm import Maths\n# class shortcut\nmaths = Maths(font_type=\"Sans_Serif\")\n# or\nmaths = Maths(font_type=\"Sans_Serif_bold\")\n# or\nmaths = Maths(font_type=\"Sans_Serif_italic\")\n# or\nmaths = Maths(font_type=\"Sans_Serif_bold_italic\")\n# or\nmaths = Maths(font_type=\"Mathematical_bold\")\n# or\nmaths = Maths(font_type=\"Mathematical_italic\")\n# or\nmaths = Maths(font_type=\"Mathematical_Fraktur\")\n# or\nmaths = Maths(font_type=\"Mathematical_bold_Fraktur\")\n# or\nmaths = Maths(font_type=\"Mathematical_double_struck\")\n# or\nmaths = Maths(font_type=\"Mathematical_monospace\")\n# converet string model to any unicode font ,\nconverted_text = maths.Convert(\"Hello World\")\nprint(converted_text)\n```\n\n---\n## Alpha Mode (Convert Font String)\n\nConvert String Text To Unicode Font Display\n\n```python\nfrom xTerm import Alpha\n# shortcut class\nalpha = Alpha.Maths(font_type=\"Sans_Serif_bold_italic\")\n# text string for convert\nconverted_text = alpha.Convert(\"Hello World\")\n# Print Output\nprint(converted_text)\n# Hello World\n```\n\n## Table Mode (Create Table Data on Terminal)\n\nDraw Table Data On Any Terminal\n\n```python\nfrom xTerm import Table\ntable = Table([[\"User01\", \"34\"], [\"User02\", \"56\"]], [\"User\", \"ID\"], \"simple_grid\")\nprint(table)\n```\nOutput:\n\n```\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 User \u2502 ID \u2502\n\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n\u2502 User01 \u2502 34 \u2502\n\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n\u2502 User02 \u2502 56 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n---\n\n```python\nfrom xTerm import Table\n# Create Table Data List\ntable = Table([\n [\"File 01\", 233345],\n [\"File 02\", 545660],\n [\"File 03\", 100057],\n [\"File 04\", 438103]],\n [\"File Name\", \"Download\"]\n , \"simple_grid\")\n# Output:\n# \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n# \u2502 File Name \u2502 Download \u2502\n# \u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n# \u2502 File 01 \u2502 233345 \u2502\n# \u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n# \u2502 File 02 \u2502 545660 \u2502\n# \u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n# \u2502 File 03 \u2502 100057 \u2502\n# \u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n# \u2502 File 04 \u2502 438103 \u2502\n# \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n---\n\n## Table Funcation\n\n\n- `table_data`: Any,\n- `headers`: tuple = (),\n- `tablefmt`: str = \"simple\",\n- `floatfmt`: str = _DEFAULT_FLOATFMT,\n- `intfmt`: str = _DEFAULT_INTFMT,\n- `numalign`: str = _DEFAULT_ALIGN,\n- `stralign`: str = _DEFAULT_ALIGN,\n- `missingval`: str = _DEFAULT_MISSINGVAL,\n- `showindex`: str = \"default\",\n- `disable_numparse`: bool = False,\n- `colglobalalign`: Any = None,\n- `colalign`: Any = None,\n- `maxcolwidths`: Any = None,\n- `headersglobalalign`: Any = None,\n- `headersalign`: Any = None,\n- `rowalign`: Any = None,\n- `maxheadercolwidths`: Any = None) -> JupyterHTMLStr | LiteralString | str\n\n---\n\n### Table formatting\n\nThere is more than one way to format a table in plain text. The third optional argument named tablefmt defines how the\ntable is formatted.\n\nSupported table formats are:\n\n| Parameter | Type | Value | Parameter | Type | Value |\n|:-------------|:--------:|:------------------|--------------:|:--------:|:------------------|\n| **tablefmt** | _string_ | `plain` | **tablefmt** | _string_ | `orgtbl` | \n| **tablefmt** | _string_ | `simple` | **tablefmt** | _string_ | `asciidoc` | \n| **tablefmt** | _string_ | `github` | **tablefmt** | _string_ | `jira` | \n| **tablefmt** | _string_ | `grid` | **tablefmt** | _string_ | `presto` | \n| **tablefmt** | _string_ | `simple_grid` | **tablefmt** | _string_ | `pretty` | \n| **tablefmt** | _string_ | `rounded_grid` | **tablefmt** | _string_ | `psql` | \n| **tablefmt** | _string_ | `heavy_grid` | **tablefmt** | _string_ | `rst` | \n| **tablefmt** | _string_ | `mixed_grid` | **tablefmt** | _string_ | `mediawiki` | \n| **tablefmt** | _string_ | `double_grid` | **tablefmt** | _string_ | `moinmoin` | \n| **tablefmt** | _string_ | `fancy_grid` | **tablefmt** | _string_ | `youtrack` | \n| **tablefmt** | _string_ | `outline` | **tablefmt** | _string_ | `html` | \n| **tablefmt** | _string_ | `simple_outline` | **tablefmt** | _string_ | `unsafehtml` | \n| **tablefmt** | _string_ | `rounded_outline` | **tablefmt** | _string_ | `latex` | \n| **tablefmt** | _string_ | `heavy_outline` | **tablefmt** | _string_ | `latex_raw` | \n| **tablefmt** | _string_ | `mixed_outline` | **tablefmt** | _string_ | `latex_booktabs` | \n| **tablefmt** | _string_ | `double_outline` | **tablefmt** | _string_ | `latex_longtable` | \n| **tablefmt** | _string_ | `fancy_outline` | **tablefmt** | _string_ | `textile` | \n| **tablefmt** | _string_ | `pipe` | **tablefmt** | _string_ | `tsv` | \n\nMore details : [table](https://xterm.readthedocs.io/en/latest/table/ 'xTerm Table Terminal') | [Notebook Example](https://deepnote.com/app/vector3/xTerm-5a0d16cf-d30e-4373-8564-4b5f7b2d0ed3)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Professional modding to the terminal and changing the font of string texts",
"version": "1.6.3",
"project_urls": {
"Homepage": "https://github.com/xTerm/xTerm"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28364fb8c8d74bb399e9ea474c39414dfb212be950a515732cd36602b0bb56f2",
"md5": "e449c6141a2da9413e32346fce1f9b6c",
"sha256": "bf3a1b0e15b2396e2ba25cb13b4a72d0576befe1cc2bb4c40d0785efc8373212"
},
"downloads": -1,
"filename": "xTerm-1.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e449c6141a2da9413e32346fce1f9b6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 30751,
"upload_time": "2024-11-02T18:40:43",
"upload_time_iso_8601": "2024-11-02T18:40:43.953196Z",
"url": "https://files.pythonhosted.org/packages/28/36/4fb8c8d74bb399e9ea474c39414dfb212be950a515732cd36602b0bb56f2/xTerm-1.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "20337631e8a0ad008995361a2abb8d21dcd3221fa2977dd1db2b142a8dc6dd10",
"md5": "881ccc3530fbe672b0278034e6b759a6",
"sha256": "e3f949ed09bf8df44f5fe44935f8511e3c93bbddf2aecf927264eaf41c90ced2"
},
"downloads": -1,
"filename": "xterm-1.6.3.tar.gz",
"has_sig": false,
"md5_digest": "881ccc3530fbe672b0278034e6b759a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 32328,
"upload_time": "2024-11-02T18:40:45",
"upload_time_iso_8601": "2024-11-02T18:40:45.405182Z",
"url": "https://files.pythonhosted.org/packages/20/33/7631e8a0ad008995361a2abb8d21dcd3221fa2977dd1db2b142a8dc6dd10/xterm-1.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 18:40:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xTerm",
"github_project": "xTerm",
"github_not_found": true,
"lcname": "xterm"
}
