https://github.com/devforfu/needle

A package helping to navigate nested structures easily
https://github.com/devforfu/needle

cli debugging python rich utils

Last synced: about 1 year ago
JSON representation

A package helping to navigate nested structures easily

• Host: GitHub
• URL: https://github.com/devforfu/needle
• Owner: devforfu
• License: apache-2.0
• Created: 2023-02-24T23:01:03.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-13T22:02:09.000Z (over 3 years ago)
• Last Synced: 2025-03-09T04:18:20.394Z (over 1 year ago)
• Topics: cli, debugging, python, rich, utils
• Language: Python
• Homepage:
• Size: 798 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Needle

Navigating nested structures easily.

## Description

The idea behind this package is to provide a simple interface allowing to "flatten" nested structures into 

a plain table where each key is represented as a fully qualified name that leads to a certain field in the

structure. It is especially useful when dealing with complex configuration objects that are merged into one

from several files or container, and include very long keys that aren't easily visualized via pretty printing.

## Functionality

The package's goal is to provide a simple interface for navigating configurations right in the terminal while

debugging an executed script. It provides two basic high-level functions:

```python

from needle import search, view

obj = { ... }  # some nested object

# parsing keys (with optional depth limitation)

s = search(obj, max_depth=3)  

print(s.top.flat_keys)   # all keys available on the topmost level

s.subsearch("dataset")   # navigating to the "dataset" subsection

print(s.top.flat_keys)   # now, the "dataset" subsection is on the top of the stack

view(obj)                # starts an interactive mode as showed below 

```

## Showcase

![](https://raw.githubusercontent.com/devforfu/needle/main/docs/quick_example.gif)

## Why?

The author of this package encountered a problem of navigating a deeply nested objects often enough to bother

writing a dedicated package that (in his opinion) should simplify that endeavor.