fastapi-voyager 0.12.3__py3-none-any.whl → 0.12.4__py3-none-any.whl

fastapi_voyager/render.py

@@ -93,6 +93,8 @@ class Renderer:
 
         def render_module_schema(mod: ModuleNode, inherit_color: str | None=None, show_cluster:bool=True) -> str:
             color: str | None = inherit_color
+            cluster_color: str | None = None
+
 
             # recursively vist module from short to long:  'a', 'a.b', 'a.b.c'
             # color_flag: {'a', 'a.b.c'}
@@ -103,6 +105,7 @@ class Renderer:
                 if mod.fullname.startswith(k):  
                     module_color_flag.remove(k)
                     color = self.module_color[k]
+                    cluster_color = color if color != inherit_color else None
                     break
 
             inner_nodes = [ render_node(node, color) for node in mod.schema_nodes ]
@@ -117,7 +120,7 @@ class Renderer:
                         style="rounded"
                         label = "  {mod.name}"
                         labeljust = "l"
-                        {(f'pencolor = "{color}"' if color else 'pencolor="#ccc"')}
+                        {(f'pencolor = "{cluster_color}"' if cluster_color else 'pencolor="#ccc"')}
                         {('penwidth = 3' if color else 'penwidth=""')}
                         {inner_nodes_str}
                         {child_str}

fastapi_voyager/type_helper.py

@@ -260,7 +260,7 @@ def update_forward_refs(kls):
 
         local_attrs = getattr(shelled_type, '__dict__', {})
         if local_attrs.get(const.PYDANTIC_FORWARD_REF_UPDATED, False):
-            logger.debug(shelled_type.__qualname__, 'visited')
+            logger.debug("%s visited", shelled_type.__qualname__)
             continue
         if safe_issubclass(shelled_type, BaseModel):
             update_pydantic_forward_refs(shelled_type)

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.12.3"
+__version__ = "0.12.4"

fastapi_voyager/web/component/demo.js

@@ -0,0 +1,17 @@
+const { defineComponent, computed } = window.Vue;
+
+import { store } from '../store.js'
+
+export default defineComponent({
+  name: "Demo",
+  emits: ["close"],
+  setup() {
+    return { store };
+  },
+  template: `
+    <div>
+      <p>Count: {{ store.state.count }}</p>
+      <button @click="store.mutations.increment()">Add</button>
+    </div>
+  `
+});

fastapi_voyager/web/graph-ui.js

@@ -132,7 +132,6 @@ export class GraphUI {
         });
 
         // svg 背景点击高亮清空
-
         $(document)
           .off("click.graphui")
           .on("click.graphui", function (evt) {

fastapi_voyager/web/index.html

@@ -298,7 +298,7 @@
             <template #after>
               <div style="position: relative; width: 100%; height: 100%;">
                 <div id="graph" class="adjust-fit"></div>
-                <div style="position: absolute; left: 8px; bottom: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;">
+                <div style="position: absolute; left: 8px; top: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;">
                   <div class="q-mt-sm">
                     <q-toggle
                       v-model="state.focus"
@@ -337,21 +337,25 @@
                       title="show module cluster"
                     />
                   </div>
+                  <div class="q-mt-sm">
+                    <q-toggle
+                      v-model="state.focus"
+                      v-show="schemaCodeName"
+                      @update:model-value="val => onFocusChange(val)"
+                      label="Focus"
+                      dense
+                      title="pick a schema and toggle focus on to display related nodes only"
+                    />
+                  </div>
+                  <!-- <div class="q-mt-sm">
+                  <demo-component></demo-component>
+                  </div> -->
                 </div>
               </div>
             </template>
           </q-splitter>
         </q-page-container>
       </q-layout>
-      <!-- Detail Dialog -->
-      <q-dialog v-model="showDetail" :persistent="true" :maximized="true">
-        <detail-dialog
-          :schema-name="schemaName"
-          :show-fields="state.showFields"
-          :model-value="showDetail"
-          @close="closeDetail"
-        />
-      </q-dialog>
 
       <!-- Schema Field Filter Dialog -->
       <q-dialog

fastapi_voyager/web/store.js

@@ -0,0 +1,17 @@
+const { reactive, watch, ref } = window.Vue;
+
+const state = reactive({
+    count: 0
+})
+
+const mutations = {
+    increment() {
+        state.count += 1
+    }
+}
+
+
+export const store = {
+    state,
+    mutations
+}

fastapi_voyager/web/vue-main.js

@@ -1,6 +1,7 @@
 import SchemaFieldFilter from "./component/schema-field-filter.js";
 import SchemaCodeDisplay from "./component/schema-code-display.js";
 import RouteCodeDisplay from "./component/route-code-display.js";
+import Demo from './component/demo.js'
 import RenderGraph from "./component/render-graph.js";
 import { GraphUI } from "./graph-ui.js";
 const { createApp, reactive, onMounted, watch, ref } = window.Vue;
@@ -39,17 +40,22 @@ const app = createApp({
 
     const showDetail = ref(false);
     const showSchemaFieldFilter = ref(false);
+
     const showDumpDialog = ref(false);
     const dumpJson = ref("");
     const showImportDialog = ref(false);
     const importJsonText = ref("");
+
     const showRenderGraph = ref(false);
+
     const renderCoreData = ref(null);
+
     const schemaName = ref(""); // used by detail dialog
     const schemaFieldFilterSchema = ref(null); // external schemaName for schema-field-filter
     const schemaCodeName = ref("");
     const routeCodeId = ref("");
     const showRouteDetail = ref(false);
+
     let graphUI = null;
 
     function openDetail() {
@@ -435,13 +441,18 @@ const app = createApp({
     };
   },
 });
+
 app.use(window.Quasar);
+
 // Set Quasar primary theme color to green
 if (window.Quasar && typeof window.Quasar.setCssVar === "function") {
   window.Quasar.setCssVar("primary", "#009485");
 }
-app.component("schema-field-filter", SchemaFieldFilter);
-app.component("schema-code-display", SchemaCodeDisplay);
-app.component("route-code-display", RouteCodeDisplay);
-app.component("render-graph", RenderGraph);
+
+app.component("schema-field-filter", SchemaFieldFilter);  // shift click and see relationships
+app.component("schema-code-display", SchemaCodeDisplay);  // double click to see node details
+app.component("route-code-display", RouteCodeDisplay);  // double click to see route details
+app.component("render-graph", RenderGraph);   // for debug, render pasted dot content
+app.component('demo-component', Demo)
+
 app.mount("#q-app");

{fastapi_voyager-0.12.3.dist-info → fastapi_voyager-0.12.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.12.3
+Version: 0.12.4
 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
@@ -31,14 +31,31 @@ Description-Content-Type: text/markdown
 [![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-> This repo is still in early stage, it supports pydantic v2 only
 
 Visualize your FastAPI endpoints, and explore them interactively.
 
-[visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
+> This repo is still in early stage, it supports pydantic v2 only
+
+[live demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
 <img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
 
+with configuration:
+
+```python
+app.mount('/voyager', 
+          create_voyager(
+            app, 
+            module_color={'src.services': 'tomato'}, 
+            module_prefix='src.services', 
+            swagger_url="/docs",
+            ga_id="G-R64S7Q49VL",
+            initial_page_policy='first',
+            online_repo_url='https://github.com/allmonday/composition-oriented-development-pattern/blob/master'))
+```
+
+https://github.com/allmonday/composition-oriented-development-pattern/blob/master/src/main.py#L48
+
 ## Plan & Raodmap
 - [ideas](./docs/idea.md)
 - [changelog & roadmap](./docs/changelog.md)

{fastapi_voyager-0.12.3.dist-info → fastapi_voyager-0.12.4.dist-info}/RECORD

@@ -2,19 +2,21 @@ fastapi_voyager/__init__.py,sha256=kqwzThE1YhmQ_7jPKGlnWvqRGC-hFrRqq_lKhKaleYU,2
 fastapi_voyager/cli.py,sha256=td3yIIigEomhSdDO-Xkh-CgpEwCafwlwnpvxnT9QsBo,10488
 fastapi_voyager/filter.py,sha256=AN_HIu8-DtKisIq5mFt7CnqRHtxKewedNGyyaI82hSY,11529
 fastapi_voyager/module.py,sha256=h9YR3BpS-CAcJW9WCdVkF4opqwY32w9T67g9GfdLytk,3425
-fastapi_voyager/render.py,sha256=1S9GFQ4LnNC_Qd-yiM8Jw8FkTxt2huREppc2sO0dFxA,9820
+fastapi_voyager/render.py,sha256=7jSChISqTV2agaO55thhwyrOhqVOMux4x7k8rSQROnU,9960
 fastapi_voyager/server.py,sha256=MZNRpcXor2q8Rj3OSf6EH8NkgDChxfzUtnIY8ilRkaY,7053
 fastapi_voyager/type.py,sha256=7EL1zaIwKVRGpLig7fqaOrZGN5k0Rm31C9COfck3CSs,1750
-fastapi_voyager/type_helper.py,sha256=quQPV0dbb5JwpfpC5tL2Zad73f_fJXF2-k46ZMuXrZs,9716
-fastapi_voyager/version.py,sha256=TeMwxEaDOniKVMHjL1Q1lrmHL9cdAEzO838ewxqUUAU,49
+fastapi_voyager/type_helper.py,sha256=JXD_OE_xTARkGjWDsnO_xfvyZ0vcwViYyqCp6oEHBTM,9719
+fastapi_voyager/version.py,sha256=_-7Zp-y6CfERg3seD-eKm5cYiJTOf-VWfF-6iV8hzms,49
 fastapi_voyager/voyager.py,sha256=LiRUb0ZG2cfnyY_pwRqoeZjxb6Pu6xy_lqPiMupxoKM,13510
-fastapi_voyager/web/graph-ui.js,sha256=9ONPxQHvk4HxYq6KtKc_2VbJmUgd-gh7i3Biv1rkqC4,5734
+fastapi_voyager/web/graph-ui.js,sha256=7ynB-o8Dse6WHWlp4bmuEfa1pUZJ2YFLJKKXjr4R6wU,5733
 fastapi_voyager/web/graphviz.svg.css,sha256=zDCjjpT0Idufu5YOiZI76PL70-avP3vTyzGPh9M85Do,1563
 fastapi_voyager/web/graphviz.svg.js,sha256=lvAdbjHc-lMSk4GQp-iqYA2PCFX4RKnW7dFaoe0LUHs,16005
-fastapi_voyager/web/index.html,sha256=8cmlwQzE5tonHj_QozdKcr3z-7JFsvE7cjf70dye0y8,19377
+fastapi_voyager/web/index.html,sha256=C8gqka2omSHqx40C5_CCSMKHP-VJSPV3UFTrqQHGRtU,19635
 fastapi_voyager/web/quasar.min.css,sha256=F5jQe7X2XT54VlvAaa2V3GsBFdVD-vxDZeaPLf6U9CU,203145
 fastapi_voyager/web/quasar.min.js,sha256=h0ftyPMW_CRiyzeVfQqiup0vrVt4_QWojpqmpnpn07E,502974
-fastapi_voyager/web/vue-main.js,sha256=m6U24ythzjQuAYXUm9BsTdFrApFNqW26B0Bf7TsybqQ,13275
+fastapi_voyager/web/store.js,sha256=LPJdFxyFn8j7vOI41FKtWoB8agoqIUrR3tN5HRS_5e4,210
+fastapi_voyager/web/vue-main.js,sha256=qTPJ2CTT5T9kRR2h0DbroOGJVePRIF3e24u7JexqjPQ,13516
+fastapi_voyager/web/component/demo.js,sha256=FUwZqyMYjwf2J_YAzUBZ-gW9RFdOrz5zbxogBBYiYYE,347
 fastapi_voyager/web/component/render-graph.js,sha256=e8Xgh2Kl-nYU0P1gstEmAepCgFnk2J6UdxW8TlMafGs,2322
 fastapi_voyager/web/component/route-code-display.js,sha256=8NJPPjNRUC21gjpY8XYEQs4RBbhX1pCiqEhJp39ku6k,3678
 fastapi_voyager/web/component/schema-code-display.js,sha256=qKUMV2RFQzR8deof2iC4vyp65UaWadtVsDAXjY-i3vE,7042
@@ -26,8 +28,8 @@ fastapi_voyager/web/icon/favicon-16x16.png,sha256=JC07jEzfIYxBIoQn_FHXvyHuxESdhW
 fastapi_voyager/web/icon/favicon-32x32.png,sha256=C7v1h58cfWOsiLp9yOIZtlx-dLasBcq3NqpHVGRmpt4,1859
 fastapi_voyager/web/icon/favicon.ico,sha256=tZolYIXkkBcFiYl1A8ksaXN2VjGamzcSdes838dLvNc,15406
 fastapi_voyager/web/icon/site.webmanifest,sha256=ep4Hzh9zhmiZF2At3Fp1dQrYQuYF_3ZPZxc1KcGBvwQ,263
-fastapi_voyager-0.12.3.dist-info/METADATA,sha256=zCZqZOPMmQMh0guXA7dmVHP0QD1M8ZJKFT6dyR_hWRo,6009
-fastapi_voyager-0.12.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.12.3.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.12.3.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.12.3.dist-info/RECORD,,
+fastapi_voyager-0.12.4.dist-info/METADATA,sha256=9VUoRQ9sMRLqvukIAlC7kUi1Bcf2raXR9v9JRx7Ltbk,6523
+fastapi_voyager-0.12.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+fastapi_voyager-0.12.4.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.12.4.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.12.4.dist-info/RECORD,,

{fastapi_voyager-0.12.3.dist-info → fastapi_voyager-0.12.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any