Skip to main content
=====================
Terminal Reporter
=====================
-----
About
-----
Terminal Reporter is a lightweight console report formatting tool for tabular data. It can either write to a file or to the terminal (via stdout).

-----
Getting Started
-----
Importing the module:
>>> import TerminalWriter
Creating a title:

>>> import TerminalWriter
Creating a title:

>>> import writer
Creating a title:
>>> print(writer.title_generator("Sample Title", 10))
======================
Sample Title
======================
Creating the layout for the columns, in this case both columns have a width of 10:
>>> writer.column_generator([10, 10])
'{: <10}{: <10}\n'
Also use the column_generator with format to create a column header:
>>> writer.column_generator([10, 10]).format("column1", "column2")
'column1 column2 \n'
Generating a report is using a combination of the functions mentioned about and a list of lists:
>>> data = [["hello", "world"],
... ["goodbye", "world"]]
>>> report = writer.generate_report(writer.title_generator("hello world", 20),
... writer.column_generator([10, 10]).format("col1", "col2"),
... writer.column_generator([10, 10]),
... data)
>>> print(report)
===============================
hello world
===============================
col1 col2
=====================

hello world
goodbye world

If you want to save a report to disk, specify file_name for the display_report or leave it set to None (the default) to write it out to the console:
>>> writer.display_report(report, file_name=None)
===============================
hello world
===============================
col1 col2
=====================

hello world
goodbye world

Metadata

Release files for TerminalWriter 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for TerminalWriter 1.0.1
File Interpreter ABI Platform Actions
TerminalWriter-1.0.1-py3-none-any.whl Python 3 none any Details for TerminalWriter-1.0.1-py3-none-any.whl

Release files / TerminalWriter-1.0.1-py3-none-any.whl

Download URL TerminalWriter-1.0.1-py3-none-any.whl
Size 5.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ee2d0cbff9d86c36dcddd41d2d24960bae506d2774391432b7bf6514efd783d5
BLAKE2b-256 checksum
How to use checksums
381e78fe199bcaf9bb47b5b6ce57f2b1a55e2bff0dad8bcb7af5c0e862a27f13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for TerminalWriter 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page