Metadata-Version: 2.1
Name: nobvisual
Version: 1.0.0
Summary: Visualization of nested objets.
Home-page: https://gitlab.com/cerfacs/nobvisual
Author: CoopTeam-CERFACS
Author-email: coop@cerfacs.com
Project-URL: Homepage, https://gitlab.com/cerfacs/nobvisual
Project-URL: Documentation, https://nobvisual.readthedocs.io/en/latest/
Project-URL: Bug Tracker, https://gitlab.com/cerfacs/nobvisual/-/issues
Keywords: nested objects,tkinter,circular packing
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: PyYAML
Requires-Dist: circlify
Requires-Dist: f90nml
Requires-Dist: loguru
Requires-Dist: matplotlib
Provides-Extra: docs
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: click ; extra == 'tests'

# NOB VISUAL

Visualization of nested objects.
The main output is a circular packing in Tkinter with an "hover interaction".
By hovering over the circles, the user can peek at the content.

![example](https://cerfacs.fr/coop/images/nobvisual/nobvisual.png)

*Example of nobvisual on a folder structure. Three subfolders show a similar content. Yellow circles are binary files, blue are ASCII files*.

This last example is for a nested object build on a folder structure, but nob visual output can be run on various nested objects, particularly or JSON or YAML contents.

See the full [online documentation](https://nobvisual.readthedocs.io/en/latest/) on ReadTheDocs.

## Installation

Installation using Pypi:

```bash
> pip install nobvisual
```

## Usage

Use the CLI for a basic terminal usage.

```bash
 ---------------    NOB VISUAL  --------------------

  You are now using the Command line interface of Nob Visual a Python3
  helper to explore Nested Objects, created at CERFACS (https://cerfacs.fr).

  This package is mean to be used as a dependency of other packages, to
  provide a tkinker canvas rendering the nested structure of nesteds
  objects.

  This is a python package currently installed in your python environement.

Options:
  --help  Show this message and exit.

Commands:
  cmpfile   Compare the content of two serialization files.
  tree      Show current wkdir visually.
  treefile  Show the content of a serialization file.

```

## Acknowledgement

Nobvisual is a service created in the [EXCELLERAT Center Of Excellence](https://www.excellerat.eu/wp/), funded by the European community.
![logo](https://www.excellerat.eu/wp-content/uploads/2020/04/excellerat_logo.png)
