Skip to main content

Visualize navigation endpoints in frontend projects.

Project description

navviz

A Python CLI tool for visualizing navigation endpoints in frontend projects, including React Native Stack Navigator support.

Features

  • Detects project language/framework
  • Parses navigation/routes (React, React Native Stack Navigator, extensible to others)
  • Extracts screens from React Native Stack Navigator (<Stack.Screen name="..." />)
  • Generates navigation graphs (Graphviz/NetworkX)
  • Outputs diagrams in-terminal (ASCII/Mermaid) or as PDF

Usage

python -m navviz <project_path> [--output pdf|terminal]

React Native Stack Navigator Example

If your project uses React Navigation's Stack Navigator:

import { createStackNavigator } from '@react-navigation/stack';

const Stack = createStackNavigator();

function AppNavigator() {
	return (
		<Stack.Navigator initialRouteName="Home">
			<Stack.Screen name="Home" component={HomeScreen} />
			<Stack.Screen name="Details" component={DetailsScreen} />
		</Stack.Navigator>
	);
}

navviz will extract the screen names ("Home", "Details") and include them in the navigation graph.

Requirements

  • Python 3.8+
  • See requirements.txt for dependencies

Roadmap

  • React/JSX navigation parsing
  • React Native Stack Navigator parsing
  • Support for other frameworks/languages
  • PDF and terminal output
  • Modular plugin system

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

navviz-0.1.2.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

navviz-0.1.2-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page