feat: setup logging

Author: jeafreezy

examples/demo_graphfaker.py

@@ -1,5 +1,4 @@
-
-
+from graphfaker.logger import logger
 import marimo
 
 __generated_with = "0.13.1"
@@ -25,13 +24,15 @@ def _():
     # suppress only the single warning from unverified HTTPS
     import urllib3
     from urllib3.exceptions import InsecureRequestWarning
+
     urllib3.disable_warnings(InsecureRequestWarning)
     return
 
 
 @app.cell
 def _():
     from graphfaker.fetchers.flights import FlightGraphFetcher
+
     return (FlightGraphFetcher,)
 
 
@@ -51,13 +52,14 @@ def _(FlightGraphFetcher):
 
 @app.cell
 def _(FlightGraphFetcher):
-    flights = FlightGraphFetcher.fetch_flights(year=2024,month=1)
+    flights = FlightGraphFetcher.fetch_flights(year=2024, month=1)
     return
 
 
 @app.cell
 def _():
     from graphfaker import GraphFaker
+
     return (GraphFaker,)
 
 
@@ -82,12 +84,13 @@ def _(G_flight):
 @app.cell
 def _():
     import scipy
+
     return
 
 
 @app.cell
 def _():
-    #gf.visualize_graph(G_flight)
+    # gf.visualize_graph(G_flight)
     return
 
 
@@ -109,9 +112,12 @@ def _(G_flight):
         G_small = G_flight.subgraph(sampled).copy()
     else:
         G_small = G_flight.copy()
-
-    print("Original:", G_flight.number_of_nodes(), "nodes,", G_flight.number_of_edges(), "edges")
-    print("Small   :", G_small.number_of_nodes(), "nodes,", G_small.number_of_edges(), "edges")
+    logger.info(
+        f"Original: {G_flight.number_of_nodes()} nodes, {G_flight.number_of_edges()} edges"
+    )
+    logger.info(
+        f"Small   : {G_small.number_of_nodes()} nodes, {G_small.number_of_edges()} edges"
+    )
 
     return (G_small,)
 

examples/example_osm_faker_visualization.py

@@ -1,10 +1,12 @@
 # run_demo.py
 
 import matplotlib
-matplotlib.use("TkAgg")          # pick a GUI backend on desktop
+
+matplotlib.use("TkAgg")  # pick a GUI backend on desktop
 from graphfaker.core import GraphFaker
 import networkx as nx
 from matplotlib import pyplot as plt
+from graphfaker.logger import logger
 
 
 # visualization function for faker source
@@ -18,10 +20,14 @@ def visualize_faker_graph(self, title, k=1.5, iterations=100):
         "Place": "lightgreen",
         "Organization": "orange",
         "Event": "pink",
-        "Product": "yellow"
+        "Product": "yellow",
     }
-    node_colors = [color_map.get(data.get("type"), "gray") for _, data in self.G.nodes(data=True)]
-    nx.draw_networkx_nodes(self.G, pos, node_color=node_colors, node_size=500, alpha=0.9)
+    node_colors = [
+        color_map.get(data.get("type"), "gray") for _, data in self.G.nodes(data=True)
+    ]
+    nx.draw_networkx_nodes(
+        self.G, pos, node_color=node_colors, node_size=500, alpha=0.9
+    )
     nx.draw_networkx_edges(self.G, pos, alpha=0.4)
     labels = {node: data.get("name", node) for node, data in self.G.nodes(data=True)}
     nx.draw_networkx_labels(self.G, pos, labels=labels, font_size=8)
@@ -30,13 +36,15 @@ def visualize_faker_graph(self, title, k=1.5, iterations=100):
     plt.show()
 
 
-
 # Visualize osm data.. since it's a multigraph
-def visualize_osm(self, G: nx.Graph = None,
-                  show_edge_names: bool = False,
-                  show_node_ids: bool = False,
-                  node_size: int = 20,
-                  edge_linewidth: float = 1.0):
+def visualize_osm(
+    self,
+    G: nx.Graph = None,
+    show_edge_names: bool = False,
+    show_node_ids: bool = False,
+    node_size: int = 20,
+    edge_linewidth: float = 1.0,
+):
     """
     Visualize an OSM-derived graph using OSMnx plotting, with optional labels.
     :param G: The graph to visualize (default: last generated graph).
@@ -50,43 +58,48 @@ def visualize_osm(self, G: nx.Graph = None,
     try:
         import osmnx as ox
     except ImportError:
-        raise ImportError("osmnx is required for visualize_osm. Install via `pip install osmnx`.")
+        raise ImportError(
+            "osmnx is required for visualize_osm. Install via `pip install osmnx`."
+        )
     # Plot base OSM network
-    fig, ax = ox.plot_graph(G, node_size=node_size, edge_linewidth=edge_linewidth,
-                            show=False, close=False)
+    fig, ax = ox.plot_graph(
+        G, node_size=node_size, edge_linewidth=edge_linewidth, show=False, close=False
+    )
     # Prepare positions for labeling
-    pos = {node: (data.get('x'), data.get('y')) for node, data in G.nodes(data=True)}
+    pos = {node: (data.get("x"), data.get("y")) for node, data in G.nodes(data=True)}
     # Edge labels
     if show_edge_names:
         edge_labels = {}
         for u, v, data in G.edges(data=True):
-            name = data.get('name')
+            name = data.get("name")
             if name:
                 # OSMnx 'name' can be list or string
                 label = name if isinstance(name, str) else ",".join(name)
                 edge_labels[(u, v)] = label
-        nx.draw_networkx_edge_labels(G, pos, edge_labels=edge_labels, font_size=6, ax=ax)
+        nx.draw_networkx_edge_labels(
+            G, pos, edge_labels=edge_labels, font_size=6, ax=ax
+        )
     # Node labels
-    if show_node_ids or any('name' in d for _, d in G.nodes(data=True)):
+    if show_node_ids or any("name" in d for _, d in G.nodes(data=True)):
         labels = {}
         for node, data in G.nodes(data=True):
             if show_node_ids:
                 labels[node] = str(node)
-            elif 'name' in data:
-                labels[node] = data['name']
+            elif "name" in data:
+                labels[node] = data["name"]
         nx.draw_networkx_labels(G, pos, labels=labels, font_size=6, ax=ax)
     ax.set_title("OSM Network Visualization")
     plt.show()
 
 
-
 # Create the graph with defaults (can be overridden by user input)
 if __name__ == "__main__":
     gf = GraphFaker()
     G = gf.generate_graph(total_nodes=20, total_edges=60)
-    print("-> graphfaker generation <-")
-    print("Total nodes:", G.number_of_nodes())
-    print("Total edges:", G.number_of_edges())
+    logger.info("-> GraphFaker graph generation started <-")
+    logger.info("Graph summary:")
+    logger.info("  Total nodes: %s", G.number_of_nodes())
+    logger.info("  Total edges: %s", G.number_of_edges())
     gf.visualize_faker_graph(title="Graph Faker PoC ")
     # sg.export_graph(filename="social_knowledge_graph.graphml")
 
@@ -99,11 +112,6 @@ def visualize_osm(self, G: nx.Graph = None,
 
 # OSM network
 G_osm = gf.generate_graph(
-    source="osm",
-    place="Chinatown, San Francisco, California",
-    network_type="drive"
+    source="osm", place="Chinatown, San Francisco, California", network_type="drive"
 )
 gf.visualize_faker_graph(G_osm)
-
-
-

examples/experiment_wikidata.py

@@ -1,4 +1,5 @@
 import marimo
+from graphfaker.logger import logger
 
 __generated_with = "0.13.1"
 app = marimo.App()
@@ -8,12 +9,14 @@
 def _():
     import pandas as pd
     import SPARQLWrapper as sw
+
     return (pd,)
 
 
 @app.cell
 def _():
     import requests
+
     return (requests,)
 
 
@@ -36,12 +39,19 @@ def _(WIKIDATA_SPARQL_URL, requests):
     def run_sparql_query(query):
         """Fetch data from Wikidata using SPARQL."""
         headers = {"Accept": "application/json"}
-        response = requests.get(WIKIDATA_SPARQL_URL, params={"query": query, "format": "json"}, headers=headers)
+        response = requests.get(
+            WIKIDATA_SPARQL_URL,
+            params={"query": query, "format": "json"},
+            headers=headers,
+        )
         if response.status_code == 200:
             return response.json()["results"]["bindings"]
         else:
-            print("SPARQL Query Failed!", response.status_code)
+            logger.error(
+                "SPARQL Query Failed! Error: %s", response.status_code, exc_info=True
+            )
             return []
+
     return (run_sparql_query,)
 
 
@@ -70,12 +80,14 @@ def fetch_ceos_and_companies():
             G.add_edge(ceo_id, company_id, relationship="CEO_of")
 
         return G
+
     return (fetch_ceos_and_companies,)
 
 
 @app.cell
 def _():
     import matplotlib.pyplot as plt
+
     return
 
 
@@ -99,7 +111,13 @@ def generate_people(num=10):
             G = nx.Graph()
             for i in range(num):
                 pid = f"person_{i}"
-                G.add_node(pid, type="Person", name=fake.name(), email=fake.email(), age=random.randint(18, 80))
+                G.add_node(
+                    pid,
+                    type="Person",
+                    name=fake.name(),
+                    email=fake.email(),
+                    age=random.randint(18, 80),
+                )
             return G
 
         @staticmethod
@@ -115,20 +133,29 @@ def generate_organizations(num=5):
             G = nx.Graph()
             for i in range(num):
                 oid = f"org_{i}"
-                G.add_node(oid, type="Organization", name=fake.company(), industry=fake.job())
+                G.add_node(
+                    oid, type="Organization", name=fake.company(), industry=fake.job()
+                )
             return G
 
         @staticmethod
         def connect_people_to_organizations(G, people_nodes, org_nodes):
             for p in people_nodes:
                 org = random.choice(org_nodes)
-                G.add_edge(p, org, relationship=random.choice(["works_at", "consults_for", "owns"]))
+                G.add_edge(
+                    p,
+                    org,
+                    relationship=random.choice(["works_at", "consults_for", "owns"]),
+                )
 
         @staticmethod
         def connect_people_to_places(G, people_nodes, place_nodes):
             for p in people_nodes:
                 place = random.choice(place_nodes)
-                G.add_edge(p, place, relationship=random.choice(["lives_in", "born_in"]))
+                G.add_edge(
+                    p, place, relationship=random.choice(["lives_in", "born_in"])
+                )
+
     return (Graphfaker,)
 
 
@@ -138,8 +165,12 @@ def _(Graphfaker):
     G_fake_places = Graphfaker.generate_places(5)
     G_fake_orgs = Graphfaker.generate_organizations(5)
 
-    Graphfaker.connect_people_to_organizations(G_people, list(G_people.nodes), list(G_fake_orgs.nodes))
-    Graphfaker.connect_people_to_places(G_people, list(G_people.nodes), list(G_fake_places.nodes))
+    Graphfaker.connect_people_to_organizations(
+        G_people, list(G_people.nodes), list(G_fake_orgs.nodes)
+    )
+    Graphfaker.connect_people_to_places(
+        G_people, list(G_people.nodes), list(G_fake_places.nodes)
+    )
     return (G_people,)
 
 
@@ -157,7 +188,7 @@ def _(G_people, nx):
 
 @app.cell
 def _(ceos_and_companies):
-    print(ceos_and_companies.nodes(data=True))
+    logger.info(ceos_and_companies.nodes(data=True))
     return
 
 
@@ -182,6 +213,7 @@ def fetch_places():
             G.add_node(city_id, type="Place", name=city_name)
 
         return G
+
     return
 
 
@@ -211,12 +243,16 @@ class WikiDataQueryResults:
         A class that can be used to query data from Wikidata using SPARQL and return the results as a Pandas DataFrame or a list
         of values for a specific key.
         """
+
         def __init__(self, query: str):
             """
             Initializes the WikiDataQueryResults object with a SPARQL query string.
             :param query: A SPARQL query string.
             """
-            self.user_agent = "WDQS-example Python/%s.%s" % (sys.version_info[0], sys.version_info[1])
+            self.user_agent = "WDQS-example Python/%s.%s" % (
+                sys.version_info[0],
+                sys.version_info[1],
+            )
             self.endpoint_url = "https://query.wikidata.org/sparql"
             self.sparql = SPARQLWrapper(self.endpoint_url, agent=self.user_agent)
             self.sparql.setQuery(query)
@@ -233,7 +269,7 @@ def __transform2dicts(self, results: List[Dict]) -> List[Dict]:
             for result in results:
                 new_result = {}
                 for key in result:
-                    new_result[key] = result[key]['value']
+                    new_result[key] = result[key]["value"]
                 new_results.append(new_result)
             return new_results
 
@@ -244,7 +280,7 @@ def _load(self) -> List[Dict]:
             :return: A list of dictionaries, where each dictionary represents a result row and has keys corresponding to the
             variables in the SPARQL SELECT clause.
             """
-            results = self.sparql.queryAndConvert()['results']['bindings']
+            results = self.sparql.queryAndConvert()["results"]["bindings"]
             results = self.__transform2dicts(results)
             return results
 
@@ -255,6 +291,7 @@ def load_as_dataframe(self) -> pd.DataFrame:
             """
             results = self._load()
             return pd.DataFrame.from_dict(results)
+
     return (WikiDataQueryResults,)
 
 
@@ -273,7 +310,7 @@ def _(data_extracter):
 @app.cell
 def _(data_extracter):
     df = data_extracter.load_as_dataframe()
-    print(df.head())
+    logger.info(df.head())
     return