fastapi-voyager 0.8.1__tar.gz → 0.8.3__tar.gz

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.8.1
+Version: 0.8.3
 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
@@ -226,6 +226,8 @@ TODO: ...
 ## Changelog
 
 - 0.8:
+    - 0.8.2
+        - fix silly typo.
     - 0.8.1
         - add feature: hide primitive routes
 - 0.7:

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/README.md

@@ -199,6 +199,8 @@ TODO: ...
 ## Changelog
 
 - 0.8:
+    - 0.8.2
+        - fix silly typo.
     - 0.8.1
         - add feature: hide primitive routes
 - 0.7:

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/src/fastapi_voyager/server.py

@@ -32,8 +32,8 @@ class Payload(BaseModel):
 	route_name: Optional[str] = None
 	show_fields: str = 'object'
 	show_meta: bool = False
-	brief: bool = False,
-	hide_primitive_route: bool = False,
+	brief: bool = False
+	hide_primitive_route: bool = False
 
 def create_route(
 	target_app: FastAPI,
@@ -66,6 +66,7 @@ def create_route(
 
 	@router.post("/dot", response_class=PlainTextResponse)
 	def get_filtered_dot(payload: Payload) -> str:
+		print(payload)
 		voyager = Voyager(
 			include_tags=payload.tags,
 			schema=payload.schema_name,

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.8.1"
+__version__ = "0.8.3"

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/src/fastapi_voyager/voyager.py

@@ -92,8 +92,8 @@ class Voyager:
             # filter by route_name (route.id) if provided
             if self.route_name is not None and route_id != self.route_name:
                 continue
+
             is_primitive_response = is_non_pydantic_type(route.response_model)
-            
             # filter primitive route if needed
             if self.hide_primitive_route and is_primitive_response:
                 continue
@@ -286,7 +286,6 @@ class Voyager:
         return renderer.render_dot(_tags, _routes, _nodes, _links)
     
     def render_brief_dot(self, module_prefix: str | None = None):
-        print(module_prefix)
         _tags, _routes, _nodes, _links = filter_subgraph(
             module_prefix=module_prefix,
             tags=self.tags,

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/src/fastapi_voyager/web/graph-ui.js

@@ -110,7 +110,7 @@ export class GraphUI {
     });
   }
 
-  async render(dotSrc) {
+  async render(dotSrc, resetZoom = true) {
     const height = this.options.height || "100%";
     return new Promise((resolve, reject) => {
       try {
@@ -126,7 +126,7 @@ export class GraphUI {
           .renderDot(dotSrc)
           .on("end", () => {
             $(this.selector).data("graphviz.svg").setup();
-            this.graphviz.resetZoom();
+            if (resetZoom) this.graphviz.resetZoom();
             resolve();
           });
       } catch (err) {

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/src/fastapi_voyager/web/index.html

@@ -89,13 +89,20 @@
       >
         <div class="row items-center q-col-gutter-md">
           <div class="col-auto">
-            <div style="width: 282px; margin-left: 8px;" class="text-h6">FastAPI Voyager</div>
+            <div
+              style="width: 282px; margin-left: 8px"
+              class="text-h6 text-primary"
+            >
+              <q-icon class="q-mr-sm" name="satellite_alt"></q-icon>
+              <span> FastAPI Voyager </span>
+            </div>
           </div>
           <div class="col-auto">
             <div class="column">
               <q-option-group
                 v-model="state.showFields"
                 :options="state.fieldOptions"
+                @update:model-value="(val) => toggleShowField(val)"
                 color="primary"
                 type="radio"
                 inline
@@ -104,7 +111,6 @@
             </div>
           </div>
 
-
           <!-- <div class="col-auto">
             <q-btn-dropdown
               class="q-ml-md"
@@ -126,11 +132,31 @@
           </div> -->
 
           <div class="col-auto q-ml-auto">
-            <q-toggle class="q-ml-md" v-model="state.brief" label="Brief Mode" title="config module_prefix to enable it" dense />
-            <q-toggle class="q-ml-md" v-model="state.hidePrimitiveRoute" label="Hide Primitive Routes" title="" dense />
+            <q-toggle
+              class="q-ml-md"
+              v-model="state.brief"
+              label="Brief Mode"
+              @update:model-value="(val) => toggleBrief(val)"
+              title="skip middle classes, config module_prefix to enable it"
+              dense
+            />
+          </div>
+          <div class="col-auto">
+            <q-toggle
+              v-model="state.hidePrimitiveRoute"
+              @update:model-value="(val) => toggleHidePrimitiveRoute(val)"
+              label="Hide Primitive"
+              title="hide routes return primitive"
+              dense
+            />
           </div>
           <div class="col-auto">
-            <q-btn outline @click="onReset" title="may be very slow" label="Show All" />
+            <q-btn
+              outline
+              @click="onReset"
+              title="may be very slow"
+              label="Show All"
+            />
           </div>
           <div class="col-auto">
             <q-btn outline icon="search" label="Search" @click="showDialog()" />
@@ -171,57 +197,80 @@
           </div>
         </div>
       </div>
-      <div class="row no-wrap" style="flex: 1 1 auto; min-height: 0; height: 100px;">
-        <div
-          class="column no-wrap"
-          :style="{
-            minWidth: '300px',
-            width: '300px',
-            borderRight: '1px solid #e0e0e0',
-            backgroundColor: '#fff',
-            minHeight: 0,
-          }"
+      <div style="flex: 1 1 auto; min-height: 0;">
+        <q-splitter
+          v-model="state.splitter"
+          unit="px"
+          :limits="[200, 800]"
+          class="fit"
         >
-          <q-scroll-area class="fit">
-            <q-list dense separator>
-              <q-expansion-item
-                v-for="tag in state.rawTags"
-                :key="tag.name"
-                expand-separator
-                :model-value="state.tag === tag.name"
-                @update:model-value="(val) => toggleTag(tag.name, val)"
-                :header-class="state.tag === tag.name ? 'text-primary text-bold' : ''"
-                content-class="q-pa-none"
-              >
-                <template #header>
-                  <div class="row items-center" style="width: 100%">
-                    <div class="">{{ tag.name }}</div>
-                  </div>
-                </template>
-
-                <q-list separator>
-                  <q-item
-                    v-for="route in (state.hidePrimitiveRoute ? tag.routes.filter(r => !r.is_primitive) :tag.routes || [])"
-                    :key="route.id"
-                    clickable
-                    v-ripple
-                    :active="state.routeId === route.id"
-                    active-class=""
-                    @click="selectRoute(route.id)"
+          <template #before>
+            <div
+              id="tag-navigator"
+              class="column no-wrap"
+              :style="{
+                borderRight: '1px solid #e0e0e0',
+                backgroundColor: '#fff',
+                minHeight: 0,
+                height: '100%'
+              }"
+            >
+              <q-scroll-area class="fit">
+                <q-list dense separator>
+                  <q-expansion-item
+                    v-for="tag in state.rawTags"
+                    :key="tag.name"
+                    expand-separator
+                    :model-value="state.tag === tag.name"
+                    @update:model-value="(val) => toggleTag(tag.name, val)"
+                    :header-class="state.tag === tag.name ? 'text-primary text-bold' : ''"
+                    content-class="q-pa-none"
                   >
-                    <q-item-section>
-                      <span class="q-ml-sm"> <span style="font-weight: bold;">⋅</span> &nbsp; {{ route.name }}</span>
-                    </q-item-section>
-                  </q-item>
-                  <q-item v-if="!tag.routes || tag.routes.length === 0" dense>
-                    <q-item-section class="text-grey-6">No routes</q-item-section>
-                  </q-item>
+                    <template #header>
+                      <div class="row items-center" style="width: 100%">
+                        <div class="row items-end">
+                          <q-icon
+                            class="q-mr-sm"
+                            :name="state.tag == tag.name ? 'folder' : 'folder_open'"
+                          ></q-icon>
+                          <span>{{ tag.name }}</span>
+                        </div>
+                      </div>
+                    </template>
+
+                    <q-list separator>
+                      <q-item
+                        v-for="route in (state.hidePrimitiveRoute ? tag.routes.filter(r => !r.is_primitive) :tag.routes || [])"
+                        :key="route.id"
+                        clickable
+                        v-ripple
+                        :active="state.routeId === route.id"
+                        active-class=""
+                        @click="selectRoute(route.id)"
+                      >
+                        <q-item-section>
+                          <span class="q-ml-lg" style="white-space: nowrap">
+                            <q-icon class="q-mr-sm" name="data_object"></q-icon>
+                            {{ route.name }}
+                          </span>
+                        </q-item-section>
+                      </q-item>
+                      <q-item v-if="!tag.routes || tag.routes.length === 0" dense>
+                        <q-item-section class="text-grey-6"
+                          >No routes</q-item-section
+                        >
+                      </q-item>
+                    </q-list>
+                  </q-expansion-item>
                 </q-list>
-              </q-expansion-item>
-            </q-list>
-          </q-scroll-area>
-        </div>
-        <div id="graph"></div>
+              </q-scroll-area>
+            </div>
+          </template>
+
+          <template #after>
+            <div id="graph" class="fit"></div>
+          </template>
+        </q-splitter>
       </div>
 
       <!-- Detail Dialog -->

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/src/fastapi_voyager/web/vue-main.js

@@ -29,6 +29,8 @@ const app = createApp({
       rawSchemas: [], // [{ name, fullname }]
       rawSchemasFull: [], // full objects with source_code & fields
       initializing: true,
+      // Splitter size (left panel width in px)
+      splitter: 300,
     });
     const showDetail = ref(false);
     const showSchemaFieldFilter = ref(false);
@@ -115,7 +117,7 @@ const app = createApp({
       }
     }
 
-    async function onGenerate() {
+    async function onGenerate(resetZoom=true) {
       state.generating = true;
       try {
         const payload = {
@@ -157,7 +159,7 @@ const app = createApp({
           },
         });
 
-        await graphUI.render(dotText);
+        await graphUI.render(dotText, resetZoom);
       } catch (e) {
         console.error("Generate failed", e);
       } finally {
@@ -231,15 +233,16 @@ const app = createApp({
       state.tag = null;
       state.routeId = "";
       state.schemaFullname = null;
-      state.showFields = "object";
+      // state.showFields = "object";
       state.brief = false;
       onGenerate()
-      // await loadInitial();
     }
 
     function toggleTag(tagName, expanded = null) {
       if (expanded === true) {
         state.tag = tagName;
+        state.routeId = ''
+        onGenerate();
         return;
       }
     }
@@ -253,43 +256,20 @@ const app = createApp({
       onGenerate()
     }
 
-    // react to tag changes to rebuild routes
-    watch(
-      () => state.tag,
-      (val) => {
-        if (!state.initializing) {
-          state.routeId = ''
-          onGenerate();
-        }
-      }
-    );
-
-    watch(
-      () => state.showFields,
-      () => {
-        if (!state.initializing) {
-          onGenerate();
-        }
-      }
-    )
-
-    watch(
-      () => state.brief,
-      () => {
-        if (!state.initializing) {
-          onGenerate();
-        }
-      }
-    );
+    function toggleShowField(field) {
+      state.showFields = field;
+      onGenerate(false)
+    }
 
-    watch(
-      () => state.hidePrimitiveRoute,
-      () => {
-        if (!state.initializing) {
-          onGenerate();
-        }
-      }
-    );
+    function toggleBrief(val) {
+      state.brief = val;
+      onGenerate()
+    }
+    
+    function toggleHidePrimitiveRoute(val) {
+      state.hidePrimitiveRoute = val;
+      onGenerate(false)
+    }
 
     onMounted(async () => {
       await loadInitial();
@@ -298,6 +278,8 @@ const app = createApp({
     return {
       state,
       toggleTag,
+      toggleBrief,
+      toggleHidePrimitiveRoute,
       selectRoute,
       onFilterTags,
       onFilterSchemas,
@@ -326,10 +308,15 @@ const app = createApp({
       // render graph dialog
       showRenderGraph,
       renderCoreData,
+      toggleShowField
     };
   },
 });
 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);

{fastapi_voyager-0.8.1 → fastapi_voyager-0.8.3}/tests/demo.py

@@ -80,5 +80,5 @@ def get_page_test_2():
     return {}
 
 @app.get("/page_test_3/", tags=['for-page'], response_model=bool)
-def get_page_test_3():
+def get_page_test_3_long_long_long_name():
     return True