Add metadata and metadata checker

Author: kesmit13

.pre-commit-config.yaml

@@ -16,7 +16,6 @@ repos:
     rev: 5.0.4
     hooks:
     -   id: flake8
-        exclude: singlestoredb/clients/pymysqlsv/
         additional_dependencies: [flake8-typing-imports==1.12.0]
 -   repo: https://github.com/pre-commit/mirrors-autopep8
     rev: v1.6.0
@@ -49,3 +48,9 @@ repos:
         language: system
         files: \.ipynb$
         exclude: notebooks/notebook-style-guide/notebook.ipynb
+    -   id: toml-check
+        name: toml-check
+        entry: resources/toml-check.py
+        language: system
+        files: \.toml$
+        exclude: ^meta.toml

notebooks/atlas-and-kai/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="Mongo Atlas & SingleStore Kai"
-description=""
+description="""\
+    Run your MongoDB queries on SingleStore Kai with no code change. \
+    """
+icon="database"
 tags=["mongodb", "kai"]
+destinations=["spaces"]

notebooks/getting-started-with-notebooks/meta.toml

@@ -1,4 +1,9 @@
 [meta]
 title="Getting Started with Notebooks"
-description=""
-tags=[]
+description="""\
+    SingleStore Notebooks with an AI Copilot (SQrL) for data prototyping, \
+    visualization and analysis. \
+    """
+icon="notes"
+tags=["beginner", "sqrl"]
+destinations=["spaces"]

notebooks/image-matching-with-sql/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="Image Matching with SQL"
-description=""
-tags=[]
+description="""\
+    Facial recognition using dot_product function on vectors stored in SingleStoreDB. \
+    """
+icon="face-viewfinder"
+tags=["vectordb", "genai", "facenet"]
+destinations=["spaces"]

notebooks/launch-open-source-apps-with-langchain/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="Launch Open-Source Apps with LangChain"
-description=""
-tags=[]
+description="""\
+    LangChain connector to use SingleStoreDB as your vector database for your apps. \
+    """
+icon=""
+tags=["vectordb", "genai", "langchain"]
+destinations=[]

notebooks/movie-recommendation/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="Movie Recommendation"
-description=""
-tags=[]
+description="""\
+    Movie recommendation engine using vectors stored in SingleStore to find your next watch. \
+    """
+icon="camera-movie"
+tags=["vectordb", "genai", "openai"]
+destinations=["spaces"]

notebooks/notebook-basics/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="SingleStoreDB Notebook Basics"
-description=""
-tags=[]
+description="""\
+    Foundational guide to notebooks with essential tips and tricks. \
+    """
+icon="notes"
+tags=["beginner"]
+destinations=["spaces"]

notebooks/notebook-style-guide/meta.toml

@@ -1,4 +1,6 @@
 [meta]
 title="Notebook Style Guide"
-description="Sample notebook template for writing Spaces notebooks"
+description="Become a pro at formatting and organizing your notebooks."
+icon="link"
 tags=[]
+destinations=[]

notebooks/semantic-search-with-openai-embedding-creation/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="Semantic Search with OpenAI Embedding Creation"
-description=""
-tags=["openai"]
+description="""\
+    Generate embeddings and run semantic search in your database in SQL. \
+    """
+icon="chart-network"
+tags=["openai", "vectordb", "genai"]
+destinations=["spaces"]

notebooks/semantic-search-with-openai-qa/meta.toml

@@ -1,4 +1,8 @@
 [meta]
 title="Semantic Search with OpenAI QA"
-description=""
-tags=["openai"]
+description="""\
+    Provide context to chatGPT using data stored in SingleStoreDB. \
+    """
+icon="crystal-ball"
+tags=["openai", "vectordb", "openai"]
+destinations=["spaces"]

resources/toml-check.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+import re
+import sys
+import tomllib
+
+
+def error(msg):
+    print('ERROR:', msg, file=sys.stderr)
+    sys.exit(1)
+
+
+for f in sys.argv[1:]:
+
+    with open(f, 'r') as infile:
+        info = tomllib.loads(infile.read())
+
+    if 'meta' not in info:
+        error(f'No `meta` section in `{f}`')
+
+    # The meta section requires, title, description, and icon
+    meta = info['meta']
+
+    if 'title' not in meta:
+        error(f'No `title` in `meta` section of {f}')
+
+    if 'description' not in meta:
+        error(f'No `description` in `meta` section of {f}')
+
+    if 'icon' not in meta:
+        error(f'No `icon` in `meta` section of {f}')
+
+    # Tags must be all lower-case, ascii letters
+    tags = meta.get('tags', [])
+
+    if [x.lower() for x in tags] != tags:
+        error(f'Tags must be in all lower-case ({tags}) in {f}')
+
+    if [re.sub(r'[^a-z]', r'', x) for x in tags] != tags:
+        error(f'Tags can only contain letters ({tags}) in {f}')
+
+    # Currently only "spaces" is allowed in destinations
+    destinations = meta.get('destinations', [])
+
+    if destinations and [x for x in destinations if x != 'spaces']:
+        error(f'Only "spaces" is allowed in `destinations` in {f}')