terminaltables3


Nameterminaltables3 JSON
Version 4.0.0 PyPI version JSON
download
home_pagehttps://github.com/matthewdeanmartin/terminaltables3
SummaryGenerate simple tables in terminals from a nested list of strings. Fork of terminaltables.
upload_time2024-07-21 17:07:26
maintainerNone
docs_urlNone
authorRobpol86
requires_python>=3.8
licenseMIT
keywords shell bash ansi ascii terminal tables
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # What is it

Easily draw tables in terminal/console applications from a list of lists of strings. Supports multi-line rows.

Tested on Python 3.8+

**This is a fork of the terminaltables project. Which is archived and unmaintained. This library is in a new namespace
but should otherwise be a drop in replacement. Maintaining goals consist of maintaining ecosystem compatibility, type
annotations and responding to community pull requests.**

To Upgrade
==========
Replace all instances of `terminaltables` with `terminaltables3` in your code. If other libraries depend on `terminaltables`
in your venv they will not conflict because it is a new namespace.

As of right now, the documentation as the robpol86 version.

📖 Full documentation: https://robpol86.github.io/terminaltables

Quickstart
==========

Install:

```bash
pip install terminaltables3
```

Usage:

```python
from terminaltables3 import AsciiTable

table_data = [
    ["Heading1", "Heading2"],
    ["row1 column1", "row1 column2"],
    ["row2 column1", "row2 column2"],
    ["row3 column1", "row3 column2"],
]
table = AsciiTable(table_data)
print
table.table
```

```bash
+--------------+--------------+
| Heading1     | Heading2     |
+--------------+--------------+
| row1 column1 | row1 column2 |
| row2 column1 | row2 column2 |
| row3 column1 | row3 column2 |
+--------------+--------------+
```

Example Implementations
=======================
![Example Scripts Screenshot](https://github.com/matthewdeanmartin/terminaltables/blob/master/docs/examples.png?raw=true)

Source code for examples:

- [example1.py](https://github.com/matthewdeanmartin/terminaltables/blob/master/example1.py)
- [example2.py](https://github.com/matthewdeanmartin/terminaltables/blob/master/example2.py)
- [example3.py](https://github.com/matthewdeanmartin/terminaltables/blob/master/example3.py)

[Change Log](https://github.com/matthewdeanmartin/terminaltables/blob/master/CHANGELOG.md)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/matthewdeanmartin/terminaltables3",
    "name": "terminaltables3",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "Shell, Bash, ANSI, ASCII, terminal, tables",
    "author": "Robpol86",
    "author_email": "robpol86@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/55/9b/9abd7feb0cf552061cfa452c22773f3158cdad877ad5623f13edfa07116f/terminaltables3-4.0.0.tar.gz",
    "platform": null,
    "description": "# What is it\n\nEasily draw tables in terminal/console applications from a list of lists of strings. Supports multi-line rows.\n\nTested on Python 3.8+\n\n**This is a fork of the terminaltables project. Which is archived and unmaintained. This library is in a new namespace\nbut should otherwise be a drop in replacement. Maintaining goals consist of maintaining ecosystem compatibility, type\nannotations and responding to community pull requests.**\n\nTo Upgrade\n==========\nReplace all instances of `terminaltables` with `terminaltables3` in your code. If other libraries depend on `terminaltables`\nin your venv they will not conflict because it is a new namespace.\n\nAs of right now, the documentation as the robpol86 version.\n\n\ud83d\udcd6 Full documentation: https://robpol86.github.io/terminaltables\n\nQuickstart\n==========\n\nInstall:\n\n```bash\npip install terminaltables3\n```\n\nUsage:\n\n```python\nfrom terminaltables3 import AsciiTable\n\ntable_data = [\n    [\"Heading1\", \"Heading2\"],\n    [\"row1 column1\", \"row1 column2\"],\n    [\"row2 column1\", \"row2 column2\"],\n    [\"row3 column1\", \"row3 column2\"],\n]\ntable = AsciiTable(table_data)\nprint\ntable.table\n```\n\n```bash\n+--------------+--------------+\n| Heading1     | Heading2     |\n+--------------+--------------+\n| row1 column1 | row1 column2 |\n| row2 column1 | row2 column2 |\n| row3 column1 | row3 column2 |\n+--------------+--------------+\n```\n\nExample Implementations\n=======================\n![Example Scripts Screenshot](https://github.com/matthewdeanmartin/terminaltables/blob/master/docs/examples.png?raw=true)\n\nSource code for examples:\n\n- [example1.py](https://github.com/matthewdeanmartin/terminaltables/blob/master/example1.py)\n- [example2.py](https://github.com/matthewdeanmartin/terminaltables/blob/master/example2.py)\n- [example3.py](https://github.com/matthewdeanmartin/terminaltables/blob/master/example3.py)\n\n[Change Log](https://github.com/matthewdeanmartin/terminaltables/blob/master/CHANGELOG.md)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Generate simple tables in terminals from a nested list of strings. Fork of terminaltables.",
    "version": "4.0.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/matthewdeanmartin/terminaltables3/issues",
        "Change Log": "https://github.com/matthewdeanmartin/terminaltables3/blob/master/CHANGELOG.md",
        "Documentation": "https://github.com/matthewdeanmartin/terminaltables3",
        "Homepage": "https://github.com/matthewdeanmartin/terminaltables3",
        "Repository": "https://github.com/matthewdeanmartin/terminaltables3"
    },
    "split_keywords": [
        "shell",
        " bash",
        " ansi",
        " ascii",
        " terminal",
        " tables"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ea666053d908e5789877ee702c102935634961a731e3db7d1caa2f1201a99598",
                "md5": "8b536a08ad91ebcc98ce371b8594ed31",
                "sha256": "93b4c722f35400a7869cd630e2bbab616b129d1c47c628765c7f47baab2ca270"
            },
            "downloads": -1,
            "filename": "terminaltables3-4.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8b536a08ad91ebcc98ce371b8594ed31",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 15806,
            "upload_time": "2024-07-21T17:07:24",
            "upload_time_iso_8601": "2024-07-21T17:07:24.850134Z",
            "url": "https://files.pythonhosted.org/packages/ea/66/6053d908e5789877ee702c102935634961a731e3db7d1caa2f1201a99598/terminaltables3-4.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "559b9abd7feb0cf552061cfa452c22773f3158cdad877ad5623f13edfa07116f",
                "md5": "4f5530d10f5a63c0f7f339b600995cbc",
                "sha256": "4e3eefe209aa89005a0a34d1525739424569729ee29b5e64a8dd51c5ebdab77f"
            },
            "downloads": -1,
            "filename": "terminaltables3-4.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4f5530d10f5a63c0f7f339b600995cbc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12777,
            "upload_time": "2024-07-21T17:07:26",
            "upload_time_iso_8601": "2024-07-21T17:07:26.223563Z",
            "url": "https://files.pythonhosted.org/packages/55/9b/9abd7feb0cf552061cfa452c22773f3158cdad877ad5623f13edfa07116f/terminaltables3-4.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-21 17:07:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "matthewdeanmartin",
    "github_project": "terminaltables3",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "terminaltables3"
}
        
Elapsed time: 0.27888s