fastapi-voyager 0.4.1__tar.gz

fastapi_voyager-0.4.1/.gitignore

@@ -0,0 +1,209 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+*.dot

fastapi_voyager-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 tangkikodo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_voyager-0.4.1/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: fastapi-voyager
+Version: 0.4.1
+Summary: Visualize FastAPI application's routing tree and dependencies
+Project-URL: Homepage, https://github.com/allmonday/fastapi-voyager
+Project-URL: Source, https://github.com/allmonday/fastapi-voyager
+Author-email: Tangkikodo <allmonday@126.com>
+License: MIT
+License-File: LICENSE
+Keywords: fastapi,openapi,routing,visualization
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.110
+Requires-Dist: pydantic-resolve>=1.13.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: uvicorn; extra == 'dev'
+Description-Content-Type: text/markdown
+
+[![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
+![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
+
+> This repo is still in early stage, currently it support pydantic v2 only, previous name: fastapi-router-viz
+
+Inspect your API interactively
+
+<img width="1480" height="648" alt="image" src="https://github.com/user-attachments/assets/a6ccc9f1-cf06-493a-b99b-eb07767564bd" />
+
+## Installation
+
+```bash
+pip install fastapi-voyager
+# or
+uv add fastapi-voyager
+```
+
+
+## Dependencies
+
+- FastAPI
+- [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
+
+
+## Feature
+
+For scenarios of using FastAPI as internal API integration endpoints, `fastapi-voyager` helps to visualize the dependencies.
+
+It is also an architecture inspection tool that can identify issues in data relationships through visualization during the design phase.
+
+If the process of building the view model follows the ER model, the full potential of fastapi-voyager can be realized. It allows for quick identification of APIs  that use entities, as well as which entities are used by a specific API
+
+
+
+```shell
+git clone https://github.com/allmonday/fastapi-voyager.git
+cd fastapi-voyager
+
+voyager -m tests.demo 
+           --server --port=8001 
+           --module_color=tests.service:blue 
+           --module_color=tests.demo:tomato
+```
+
+pick tag, rotue (optional) and click `generate`.
+
+<img width="1919" height="898" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/05e321d0-49f3-4af6-a7c7-f4c9c6b1dbfd" />
+
+click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.
+
+<img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
+
+
+`shift` click a node to check related nodes.
+
+pick a field to narrow the result.
+
+<img width="1917" height="800" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/e770dc70-f293-49e1-bcd7-d8dffa15d9ea" />
+
+`alt` click a node to show source code or open file in vscode.
+
+<img width="497" height="402" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/ac81711a-d9c2-4fb1-8b3a-0f4bd1f02572" />
+
+more in video:
+
+[![IMAGE ALT TEXT](http://img.youtube.com/vi/msYsB9Cc3CA/0.jpg)](https://www.youtube.com/watch?v=msYsB9Cc3CA "Unity Snake Game")
+
+
+## Command Line Usage
+
+### open in browser
+
+```bash
+# open in browser
+voyager -m tests.demo --server  
+
+voyager -m tests.demo --server --port=8002
+```
+
+### generate the dot file
+```bash
+# generate .dot file
+voyager -m tests.demo  
+
+voyager -m tests.demo --app my_app
+
+voyager -m tests.demo --schema Task
+
+voyager -m tests.demo --show_fields all
+
+voyager -m tests.demo --module_color=tests.demo:red --module_color=tests.service:tomato
+
+voyager -m tests.demo -o my_visualization.dot
+
+voyager --version
+```
+
+The tool will generate a DOT file that you can render using Graphviz:
+
+```bash
+# Install graphviz
+brew install graphviz  # macOS
+apt-get install graphviz  # Ubuntu/Debian
+
+# Render the graph
+dot -Tpng router_viz.dot -o router_viz.png
+
+# Or view online at: https://dreampuf.github.io/GraphvizOnline/
+```
+
+or you can open router_viz.dot with vscode extension `graphviz interactive preview`
+
+
+## Plan
+
+features:
+- [x] group schemas by module hierarchy
+- [x] module-based coloring via Analytics(module_color={...})
+- [x] view in web browser
+    - [x] config params
+    - [x] make a explorer dashboard, provide list of routes, schemas, to make it easy to switch and search
+- [x] support programmatic usage
+- [x] better schema /router node appearance
+- [x] hide fields duplicated with parent's (show `parent fields` instead)
+- [x] refactor the frontend to vue, and tweak the build process
+- [x] find dependency based on picked schema and it's field.
+- [x] optimize static resource (cdn -> local)
+- [x] add configuration for highlight (optional)
+- [x] alt+click to show field details
+- [x] display source code of routes (including response_model)
+- [x] handle excluded field 
+- [ ] user can generate nodes/edges manually and connect to generated ones
+- [ ] support dataclass
+- [ ] group routes by module hierarchy
+- [ ] integration with pydantic-resolve
+    - [ ] show difference between resolve, post fields
+    - [x] strikethrough for excluded fields
+    - [ ] display loader as edges
+- [ ] test cases
+
+bugs:
+- [ ] fix duplicated link from class and parent class, it also break clicking highlight
+
+
+## Credits
+
+- https://apis.guru/graphql-voyager/, for inspiration.
+- https://github.com/tintinweb/vscode-interactive-graphviz, for web visualization.

fastapi_voyager-0.4.1/README.md

@@ -0,0 +1,148 @@
+[![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
+![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
+
+> This repo is still in early stage, currently it support pydantic v2 only, previous name: fastapi-router-viz
+
+Inspect your API interactively
+
+<img width="1480" height="648" alt="image" src="https://github.com/user-attachments/assets/a6ccc9f1-cf06-493a-b99b-eb07767564bd" />
+
+## Installation
+
+```bash
+pip install fastapi-voyager
+# or
+uv add fastapi-voyager
+```
+
+
+## Dependencies
+
+- FastAPI
+- [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
+
+
+## Feature
+
+For scenarios of using FastAPI as internal API integration endpoints, `fastapi-voyager` helps to visualize the dependencies.
+
+It is also an architecture inspection tool that can identify issues in data relationships through visualization during the design phase.
+
+If the process of building the view model follows the ER model, the full potential of fastapi-voyager can be realized. It allows for quick identification of APIs  that use entities, as well as which entities are used by a specific API
+
+
+
+```shell
+git clone https://github.com/allmonday/fastapi-voyager.git
+cd fastapi-voyager
+
+voyager -m tests.demo 
+           --server --port=8001 
+           --module_color=tests.service:blue 
+           --module_color=tests.demo:tomato
+```
+
+pick tag, rotue (optional) and click `generate`.
+
+<img width="1919" height="898" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/05e321d0-49f3-4af6-a7c7-f4c9c6b1dbfd" />
+
+click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.
+
+<img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
+
+
+`shift` click a node to check related nodes.
+
+pick a field to narrow the result.
+
+<img width="1917" height="800" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/e770dc70-f293-49e1-bcd7-d8dffa15d9ea" />
+
+`alt` click a node to show source code or open file in vscode.
+
+<img width="497" height="402" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/ac81711a-d9c2-4fb1-8b3a-0f4bd1f02572" />
+
+more in video:
+
+[![IMAGE ALT TEXT](http://img.youtube.com/vi/msYsB9Cc3CA/0.jpg)](https://www.youtube.com/watch?v=msYsB9Cc3CA "Unity Snake Game")
+
+
+## Command Line Usage
+
+### open in browser
+
+```bash
+# open in browser
+voyager -m tests.demo --server  
+
+voyager -m tests.demo --server --port=8002
+```
+
+### generate the dot file
+```bash
+# generate .dot file
+voyager -m tests.demo  
+
+voyager -m tests.demo --app my_app
+
+voyager -m tests.demo --schema Task
+
+voyager -m tests.demo --show_fields all
+
+voyager -m tests.demo --module_color=tests.demo:red --module_color=tests.service:tomato
+
+voyager -m tests.demo -o my_visualization.dot
+
+voyager --version
+```
+
+The tool will generate a DOT file that you can render using Graphviz:
+
+```bash
+# Install graphviz
+brew install graphviz  # macOS
+apt-get install graphviz  # Ubuntu/Debian
+
+# Render the graph
+dot -Tpng router_viz.dot -o router_viz.png
+
+# Or view online at: https://dreampuf.github.io/GraphvizOnline/
+```
+
+or you can open router_viz.dot with vscode extension `graphviz interactive preview`
+
+
+## Plan
+
+features:
+- [x] group schemas by module hierarchy
+- [x] module-based coloring via Analytics(module_color={...})
+- [x] view in web browser
+    - [x] config params
+    - [x] make a explorer dashboard, provide list of routes, schemas, to make it easy to switch and search
+- [x] support programmatic usage
+- [x] better schema /router node appearance
+- [x] hide fields duplicated with parent's (show `parent fields` instead)
+- [x] refactor the frontend to vue, and tweak the build process
+- [x] find dependency based on picked schema and it's field.
+- [x] optimize static resource (cdn -> local)
+- [x] add configuration for highlight (optional)
+- [x] alt+click to show field details
+- [x] display source code of routes (including response_model)
+- [x] handle excluded field 
+- [ ] user can generate nodes/edges manually and connect to generated ones
+- [ ] support dataclass
+- [ ] group routes by module hierarchy
+- [ ] integration with pydantic-resolve
+    - [ ] show difference between resolve, post fields
+    - [x] strikethrough for excluded fields
+    - [ ] display loader as edges
+- [ ] test cases
+
+bugs:
+- [ ] fix duplicated link from class and parent class, it also break clicking highlight
+
+
+## Credits
+
+- https://apis.guru/graphql-voyager/, for inspiration.
+- https://github.com/tintinweb/vscode-interactive-graphviz, for web visualization.

fastapi_voyager-0.4.1/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "fastapi-voyager"
+dynamic = ["version"]
+description = "Visualize FastAPI application's routing tree and dependencies"
+authors = [ { name = "Tangkikodo", email = "allmonday@126.com" } ]
+license = { text = "MIT" }
+readme = "README.md"
+requires-python = ">=3.10"
+keywords = ["fastapi", "visualization", "routing", "openapi"]
+dependencies = [
+  "fastapi>=0.110",
+  "pydantic-resolve>=1.13.2"
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Framework :: FastAPI",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License"
+]
+
+[project.scripts]
+voyager = "fastapi_voyager.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/allmonday/fastapi-voyager"
+Source = "https://github.com/allmonday/fastapi-voyager"
+
+[project.optional-dependencies]
+dev = ["uvicorn", "ruff", "pytest"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/fastapi_voyager/version.py"
+
+[tool.uv]
+# You can pin resolution or indexes here later.
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

fastapi_voyager-0.4.1/src/fastapi_voyager/__init__.py

@@ -0,0 +1,5 @@
+"""fastapi_voyager
+
+Utilities to introspect a FastAPI application and visualize its routing tree.
+"""
+from .version import __version__  # noqa: F401