shellviz 0.4.1

No project description provided

Shellviz

.

Shellviz is a zero-hassle Python tool that transforms your data into dynamic, real-time visualizations you can explore right in your browser. It's lightweight, free, and has no dependencies — just install and start visualizing!

🚀 Features

• Free & Easy to Use: No configuration, sign-up, or API key needed.
• Dynamic Data Manipulation:
  • Update or append to existing values seamlessly.
  • Clear logs programmatically for a fresh start.
  • View and manage multiple data sources side-by-side.
• Powerful Visualizations:
  • Visualize tables, charts, JSON, and more.
  • Search, slice, and filter data with ease.
  • Export data as CSV files.
• Interactive Second Screen: Use your phone as a second screen with QR code pairing.
• Simplified Data Analysis: Break down complex terminal output for quick insights.

🛠️ Installation

Install Shellviz with pip:

pip install shellviz

🔧 Getting Started

Basic Usage

from shellviz import log, table, json

log('my first shellviz command')
# Shellviz serving on http://127.0.0.1:5544

table([("Alice", 25, 5.6), ("Bob", 30, 5.9)])
json({"name": "Alice", "age": 25, "height": 5.6})

Open the generated URL in your browser, and you’ll see your data visualized instantly.

Advanced Usage

Update Existing Values

from shellviz import progress
progress(0.0, id='migration')
progress(1.0, id='migration') # Update data dynamically

Append Data

from shellviz import table

table([('Joe', 10)], id='users')
table([('Jane', 12)], id='users', append=True)

Clear Logs

from shellviz import clear
clear()

Second-Screen via QR Code Install the optional qrcode package for QR code support:

pip install qrcode

from shellviz import show_qr_code
show_qr_code()

🏗️ Contributing

We welcome contributions! If you encounter issues or have ideas, feel free to submit an issue or pull request on GitHub.

Developing client side code

Client-side code is written in React using the create-react-app boilerplate. To set up the client side environment, run the following

cd client
npm install
npm start

This should launch a live-updating browser window that will listen for traffic on the default Shellviz websocket port

Build

Bundling and deploying Shellviz is straightforward. Run the following command to build a compiled version of the Shellviz client that will be placed in the package's build folder:

cd client
npm run build

Once this is done, you can compile the package using poetry:

cd .. # jump to project root
poetry build

To install into a local python environment, run the following command:

poetry add --no-cache ~/[path-to-repo]/dist/shellviz-0.x.x-py3-none-any.whl

⚖️ License

Shellviz is open source and licensed under the MIT License.