zaturn 0.1.7__py3-none-any.whl → 0.2.0__py3-none-any.whl

zaturn/studio/templates/css/style.css

@@ -0,0 +1,406 @@
+/* Fonts */
+@font-face {
+  font-family: "Inter";
+  src: url('/static/inter_var.ttf');
+}
+
+@font-face {
+  font-family: "Inter";
+  font-style: italic;
+  src: url('/static/inter_ital_var.ttf');
+}
+
+@font-face {
+  font-family: "Fira Code";
+  src: url('/static/fira_code.ttf');
+}
+
+@font-face {
+  font-family: "Noto Emoji";
+  src: url('/static/noto_emoji.ttf');
+}
+
+/* Global Styles */
+* {
+  box-sizing: border-box;
+  font-family: "Inter", "Noto Emoji", sans-serif;
+  margin: 0;
+  padding: 0;
+}
+
+:root {
+  --bg0: #ffffff;
+  --bg1: #e4e9f1;
+	--bg2: #dde3ee;
+  --t1: #336e80;
+  --t2: #5dd9ac;
+  --red: #d43a3a;
+  --fg2: #3a4d74;
+  --fg1: #182030;
+	--base-size: clamp(16px, 1.4vw, 32px);
+	--max-width: calc(var(--base-size)*36);
+	font-size: var(--base-size);
+	letter-spacing: 0.02rem;
+}
+
+body {
+	font-size: 1rem;
+	background: var(--bg0);
+	color: var(--fg1);
+	margin: 0;
+	padding: 0;
+	display: grid;
+	grid-template-columns: 1fr 3fr;
+	grid-template-rows: auto 1fr;
+	align-content: stretch;
+	height: 99vh;
+	line-height: 170%;
+}
+
+a {
+	color: var(--t1);
+	cursor: pointer;
+}
+
+header {
+  grid-area: 1 / 1 / 2 / 2;
+  padding: 0.5rem;
+  display: grid;
+  align-items: center;
+  grid-template-columns: 1fr auto auto auto;
+  gap: 0.5rem;
+}
+
+header a {
+  text-decoration: none;
+}
+
+header .logo {
+  width: 2rem;
+  height: 2rem;
+}
+
+#sidebar {
+  grid-area: 2 / 1 / 3 / 2;
+  background: var(--bg0);
+  height: 100%;
+  align-self: start;
+  padding: 0 0.5rem;
+  margin: 0.25rem 0;
+  display: grid;
+  align-content: start;
+  gap: 0.25rem;
+  overflow-y: auto;
+}
+
+#sidebar a {
+  text-decoration: none;
+  display: block;
+  padding: 0.6rem 0.25rem 0.4rem 0.25rem;
+  border-top: 1px solid var(--bg2);
+  font-size: 83%;
+}
+
+main {
+  grid-area: 1 / 2 / 3 / 3;
+  justify-items: center;
+  display: grid;
+  padding: 0.5rem;
+  height: 100vh;
+  overflow-y: scroll;
+}
+
+section {
+  display: inline-block;
+  width: 100%;
+  max-width: 120vh;
+  margin: 1rem 0;
+  padding: 0.5rem;
+}
+
+section h1 {
+  margin-bottom: 2rem;
+}
+
+.btn, button {
+  text-decoration: none;
+  background: var(--bg2);
+  display: inline-block;
+  padding: 0.5rem 1rem;
+  border-radius: 0.2rem;
+  color: var(--t1);
+  font-weight: bold;
+  cursor: pointer;
+  border: 1px solid var(--t1);
+  outline: none;
+  font-size: inherit;
+}
+
+.btn.danger, button.danger {
+  color: var(--red);
+  border: 1px solid var(--red);
+}
+
+.btn:hover, button:hover, .btn:focus, button:focus {
+  opacity: 0.8;
+}
+
+code {
+  font-family: "Fira Code", monospace;
+  font-size: 0.8rem;
+}
+
+.row-c2 {
+  display: grid;
+  grid-template-columns: 1fr 1fr;
+  gap: 1rem;
+}
+
+.alert {
+  background: var(--bg0);
+  padding: 0.5rem;
+  border: 1px solid var(--bg2);
+}
+
+
+/* General Forms */
+form {
+  display: grid;
+  gap: 1.5rem;
+  background: var(--bg0);
+  padding: 1rem 0.5rem;
+}
+
+form label {
+  display: grid;
+  gap: 0.25rem;
+}
+
+form small {
+  font-size: 0.8rem;
+  font-weight: bold;
+}
+
+form input {
+  border: none;
+  outline: none;
+  font-family: "Fira Code", monospace;
+  border-bottom: 1px solid var(--fg1);
+  color: var(--fg1);
+  font-size: 0.8rem;
+  padding: 0.2rem;
+}
+
+form input:focus {
+  color: var(--t1);
+  border-bottom: 1px solid var(--t1);
+}
+
+form button {
+  justify-self: start;
+}
+
+form progress[value="0"] {
+  display: none;
+}
+
+form textarea {
+  font-size: inherit;
+  padding: 0.5rem;
+  border: none;
+  outline: none;
+}
+
+form.htmx-request {
+  display: none;
+}
+
+form ~ .loader {
+  display: none;
+  font-size: 1.2rem;
+  text-align: center;
+  padding: 2rem 0.5rem;
+  animation: loadanim 2s ease-in-out infinite;
+}
+
+form.htmx-request + .loader {
+  display: block;
+}
+
+@keyframes loadanim {
+  0% {opacity: 1;}
+  50% {opacity: 0.3;}
+  100% {opacity: 1;}
+}
+
+
+
+/*
+  SCREEN WISE CSS
+*/
+
+/* Setup Prompt */
+
+#setup-prompt {
+  margin-top: 5rem;
+}
+
+/* Manage Sources */
+
+#manage-sources .source-card {
+  display: grid;
+  grid-template-columns: 1fr auto auto;
+  padding: 1rem;
+  align-items: center;
+  gap: 1rem;
+  border-top: 1px solid var(--bg2);
+}
+
+#manage-sources .source-card form {
+  padding: 0;
+  display: inline-block;
+  background: none;
+}
+
+#manage-sources .source-card button {
+  font-size: 0.75rem;
+  padding: 0.25rem 0.5rem;
+}
+
+#manage-sources .source-card button.inactive {
+  filter: grayscale(100%);
+} 
+
+#manage-sources .row-c2 {
+  margin-top: 1.5rem;
+}
+
+#manage-sources .row-c2 form {
+  border: 1px solid var(--bg2);
+  border-radius: 0.2rem;
+}
+
+
+/* New Conversation */
+
+#new-conversation form {
+  border-top: 1px solid var(--bg2);
+  margin-top: 1rem;
+}
+
+
+/* Chat Display */
+
+#chat {
+  border-radius: 0.2rem;
+}
+
+#chat>* {
+  margin: 0;
+  border-bottom: 1px solid var(--bg2);
+  padding: 1.5rem 0.5rem;
+}
+
+#chat ul {
+  list-style-position: inside;
+}
+
+#chat .user-message {
+  display: grid;
+  grid-template-columns: auto 1fr;
+  gap: 1rem;
+  padding-right: 1rem;
+  align-items: start;
+}
+
+#chat .user-message .sender {
+  color: var(--t1);
+  border: 1px solid var(--t1);
+  padding: 0.125rem 0.5rem;
+  font-size: 70%;
+}
+
+
+
+#chat .ai-message {
+  display: grid;
+  gap: 0.25rem;
+}
+
+#chat .ai-message .sender {
+  color: var(--t1);
+  font-size: 70%;
+}
+
+
+#chat .function-call {
+  display: grid;
+  gap: 0.75rem;
+  align-items: center;
+}
+
+#chat .function-name b {
+  font-size: 75%;
+  display: inline-block;
+  background: var(--t1);
+  padding: 0rem 0.5rem;
+  border-radius: 2rem; 
+  color: var(--bg0);
+  margin-right: 0.5rem;
+}
+
+#chat .function-call pre {
+  overflow-x: auto;
+}
+
+#chat .function-name code {
+  color: var(--t1);
+  font-weight: 700;
+}
+
+#chat .function-call .args {
+  padding: 0.5rem;
+  background: var(--bg2);
+  border-radius: 0.2rem;
+  font-family: Fira Code, monospace;
+  font-size: 75%;
+  line-height: 180%;
+}
+
+#chat .function-output {
+  overflow-x: auto;
+}
+
+#chat table {
+  border-collapse: collapse;
+  border-radius: 0.25rem;
+}
+
+#chat table td, #chat table th {
+  border: 1px solid var(--bg2);
+  padding: 0.25rem 0.5rem;
+  font-family: Fira Code, monospace;
+  font-size: 75%;
+}
+
+#chat table th {
+  background: var(--t1);
+  border: 1px solid var(--t1);
+  color: var(--bg1);
+  font-weight: 700;
+}
+
+#chat table tr:nth-child(2n) td {
+  background: var(--bg1);
+  border: 1px solid var(--bg2);
+}
+
+@media print {
+  body {height: auto;}
+  header {display: none;}
+  #sidebar {display: none;}
+  main {grid-area: 1 / 1 / 3 / 3; height: auto; overflow-y: none;}
+  form {display: none;}
+}
+
+

zaturn/studio/templates/function_call.html

@@ -0,0 +1,7 @@
+<div class="function-call">
+  <pre class="function-name"><b>fn_call</b><code>{{msg['call_details']['name']}}</code></pre>
+  {% if msg['call_details']['arguments'] %}
+    <p class="args">{{msg['call_details']['arguments'] | safe}}</p>
+  {% endif %}
+  <div class="function-output">{{ msg['html'] | safe}}</div>
+</div>

zaturn/studio/templates/loader.html

@@ -0,0 +1 @@
+<p class="loader">💆‍♀️ Relax, Zaturn is running...</p>

zaturn/studio/templates/manage_sources.html

@@ -0,0 +1,45 @@
+<section id="manage-sources">
+  {% if sources %}
+    <h1>🔗 Your Data Sources</h1>
+    {% for key in sources %}
+      {% with key=key, active=sources[key]['active'] %}
+        {% include('c_source_card.html') %}
+      {% endwith %}
+    {% endfor %}
+  {% else %}
+    <h1>➕ Add Some Data</h1>
+  {% endif %}
+
+  <div class="row-c2">
+    <form 
+      id="datafile-form"
+      action="/upload_datafile" 
+      enctype='multipart/form-data'
+      method="POST"
+      >
+      <label>
+        <small>Upload A File</small>
+        <input type="file" name="datafile" accept=".csv,.db,.sqlite,.sqlite3,.duckdb,.parquet,.pq" placeholder="" required>
+        <small><em>CSV / SQLite / DuckDB / Parquet</em></small>
+      </label>
+      <button>⬆ Upload</button>
+      <progress value='0' max='100'></progress>
+    </form>
+  
+    <script>
+      htmx.on('#datafile-form', 'htmx:xhr:progress', function(evt) {
+        htmx.find('#datafile-form progress').setAttribute('value', evt.detail.loaded/evt.detail.total * 100);
+      });
+    </script>
+  
+    <form action="/add_dataurl" method="POST">
+      <label>
+        <small>Or Link A Database Using URL</small>
+        <input type="text" name="db_url" required>
+        <small><em>PostgreSQL / MySQL / Clickhouse</em></small>
+      </label>
+      <button>🔗 Connect</button>
+    </form>
+  </div>
+  
+</section>

zaturn/studio/templates/nav.html

@@ -0,0 +1,5 @@
+<nav id="sidebar">
+  {% for slug in slugs %}
+  <a href="/c/{{slug}}">{{slug}}</a>
+  {% endfor %}
+</nav>

zaturn/studio/templates/new_conversation.html

@@ -0,0 +1,13 @@
+<section id="new-conversation">
+  <h1>Vamos! ᯓ★</h1>
+  <p>An AMA Session With Your Data</p>
+  <form action="/create_new_chat" method="POST">
+    <textarea 
+      required 
+      name="question" 
+      placeholder="Type your question here...&#10E.g.: Explore the linked data and tell me something useful."
+    ></textarea>
+    <button>➡</button>
+  </form>
+  {% include('loader.html') %}
+</section>

zaturn/studio/templates/settings.html

@@ -0,0 +1,29 @@
+<section id="settings">
+  <h1>
+    <a href="/">⬅</a>
+    Settings
+  </h1>
+  
+  {% if updated %}
+  <p class="alert">
+    <code>{{updated}}</code> 
+    ✅ Settings Updated!
+  </p>
+  {% endif %}
+  
+  <form action="/save_settings" method="post">
+    <label>
+      <small>OPENAI API KEY*</small>
+      <input type="text" name="api_key" value="{{current['api_key']}}" required>
+    </label>
+    <label>
+      <small>MODEL NAME*</small>
+      <input type="text" name="api_model" value="{{current['api_model']}}" required>
+    </label>
+    <label>
+      <small>OPENAI API ENDPOINT (Leave blank to use default)</small>
+      <input type="text" name="api_endpoint" value="{{current['api_endpoint']}}">
+    </label>
+    <button>💾 Save</button>
+  </form>
+</section>

zaturn/studio/templates/setup_prompt.html

@@ -0,0 +1,6 @@
+<section id="setup-prompt">
+  <h1>Are You Ready? 🔥</h1>
+  <p>We need to set you up though.</p>
+  <p>Head over to <a href="/settings">settings</a> and add your LLM API Key.</p>
+  <p><a href="/settings" class="btn">⚙ Open Settings</a>
+</section>

zaturn/studio/templates/user_message.html

@@ -0,0 +1,4 @@
+<div class="user-message">
+  <b class="sender">You</b>
+  <p>{{msg['content']}}</p>
+</div>

zaturn/tools/__init__.py

@@ -0,0 +1,13 @@
+from zaturn.tools import core, visualizations
+
+
+class ZaturnTools:
+
+    def __init__(self, data_sources):
+        self.tools = [
+            *core.Core(data_sources).tools,
+            *visualizations.Visualizations(data_sources).tools,
+        ]
+        
+
+    

zaturn/{config.py → tools/config.py}

@@ -6,12 +6,10 @@ import sys
 
 # Basic Setup
 USER_DATA_DIR = platformdirs.user_data_dir('zaturn', 'zaturn')
-USER_CONFIG_DIR = platformdirs.user_config_dir('zaturn', 'zaturn')
 QUERIES_DIR = os.path.join(USER_DATA_DIR, 'queries')
 VISUALS_DIR = os.path.join(USER_DATA_DIR, 'visuals')
-SOURCES_FILE = os.path.join(USER_CONFIG_DIR, 'sources.txt')
+SOURCES_FILE = os.path.join(USER_DATA_DIR, 'sources.txt')
 
-os.makedirs(USER_CONFIG_DIR, exist_ok=True)
 os.makedirs(QUERIES_DIR, exist_ok=True)
 os.makedirs(VISUALS_DIR, exist_ok=True)
 
@@ -41,7 +39,7 @@ if not source_list:
     source_list = [
         pkg_resources.resource_filename(
             'zaturn',
-            os.path.join('example_data', 'all_pokemon_data.csv')
+            os.path.join('mcp', 'example_data', 'all_pokemon_data.csv')
         )
     ]
     print("No data sources provided. Loading example dataset for demonstration.")
@@ -50,7 +48,7 @@ if not source_list:
     print("zaturn_mcp sqlite:///path/to/mydata.db /path/to/my_file.csv")
     print(f"\nNOTE: Sources in command line args will be ignored if sources are found in {SOURCES_FILE}")
     
-SOURCES = {}
+CLI_SOURCES = {}
 for s in source_list:
     source = s.lower()
     if source.startswith('sqlite://'):
@@ -72,14 +70,14 @@ for s in source_list:
     elif source.endswith(".csv"):
         source_type = "csv"
         source_name = source.split('/')[-1].split('.')[0]
-    elif source.endswith(".parquet"):
+    elif source.endswith(".parquet") or source.endswith(".pq"):
         source_type = "parquet"
         source_name = source.split('/')[-1].split('.')[0]
     else:
         continue
 
     source_id = f'{source_name}-{source_type}'
-    if source_id in SOURCES:
+    if source_id in CLI_SOURCES:
         i = 2
         while True:
             source_id = f'{source_name}{i}-{source_type}'
@@ -87,11 +85,11 @@ for s in source_list:
                 break
             i += 1
 
-    SOURCES[source_id] = {'url': s, 'type': source_type}
+    CLI_SOURCES[source_id] = {'url': s, 'type': source_type}
 
 
 # Other Settings
-RETURN_IMAGES = not args.noimg
+CLI_RETURN_IMAGES = not args.noimg
 
 
 

zaturn/tools/core.py

@@ -0,0 +1,97 @@
+from typing import Any, List, Union, Annotated
+
+from pydantic import Field
+
+from zaturn.tools import query_utils
+
+
+class Core:
+
+    def __init__(self, data_sources): 
+        self.data_sources = data_sources
+        self.tools = [
+            self.list_data_sources,
+            self.describe_table,
+            self.run_query,
+        ]
+
+
+    def list_data_sources(self) -> str:
+        """
+        List all available data sources.
+        Returns a list of unique source_ids to be used for other queries.
+        Source type is included in the source_id string.
+        While drafting SQL queries use appropriate syntax as per source type.
+        """
+        try:
+            if not self.data_sources:
+                return "No data sources available. Add data sources."
+            
+            result = "Available data sources:\n\n"
+            for source_id in self.data_sources:
+                tables = query_utils.list_tables(
+                    self.data_sources[source_id]
+                )
+                if type(tables) is list:
+                    tables = ', '.join(tables)
+                result += f"- {source_id}\nHas tables: {tables}\n"
+                
+            return result
+            
+        except Exception as e:
+            return str(e)
+
+
+    def describe_table(self, 
+        source_id: Annotated[
+            str, Field(description='The data source')
+        ], 
+        table_name: Annotated[
+            str, Field(description='The table in the data source')
+        ]
+    ) -> str:
+        """
+        Lists columns and their types in the specified table of specified data source.
+        """
+        
+        try:
+            source = self.data_sources.get(source_id)
+            if not source:
+                return f"Source {source_id} Not Found"
+    
+            result = query_utils.describe_table(source, table_name)
+            return result.to_markdown(index=False)
+        
+        except Exception as e:
+            return str(e)
+
+
+    def run_query(self,
+        source_id: Annotated[
+            str, Field(description='The data source to run the query on')
+        ],  
+        query: Annotated[
+            str, Field(description='SQL query to run on the data source')
+        ]
+    ) -> str:
+        """
+        Run query against specified source
+        For both csv and parquet sources, use DuckDB SQL syntax
+        Use 'CSV' as the table name for csv sources.
+        Use 'PARQUET' as the table name for parquet sources.
+    
+        This will return a dataframe with the results.
+        """
+        
+        try:
+            source = self.data_sources.get(source_id)
+            if not source:
+                return f"Source {source_id} Not Found"
+                
+            df = query_utils.execute_query(source, query)
+            return df.to_markdown(index=False)
+        except Exception as e:
+            return str(e)
+
+
+