new commands

Author: lambdamusic

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+
+## v 1.5
+
+* Added DSL grammar for DSL [V2.13](https://docs.dimensions.ai/dsl/releasenotes.html#version-2-13-2025-november-week-of-10th)
+* Updated CLI special commands. Now starting with `/` instead of `.`
+
 ## v 1.4
 
 * Fix CLI [history bug](https://github.com/digital-science/dimcli/issues/80)

dimcli/VERSION.py

@@ -1,8 +1,8 @@
 # !/usr/bin/env python
 #  -*- coding: UTF-8 -*-
 
-__version__ = "1.4"  # LATEST? =>  https://pypi.org/project/dimcli/
-__copyright__ = "CopyRight (C) 2018-2024 by Digital Science"
+__version__ = "1.5"  # LATEST? =>  https://pypi.org/project/dimcli/
+__copyright__ = "CopyRight (C) 2018-2026 by Michele Pasin & Digital Science"
 __license__ = "MIT"
 __author__ = "Michele Pasin"
 __author_email__ = "michele dot pasin at digital dash science dot com"

dimcli/core/dsl_grammar_extras.py

@@ -10,20 +10,20 @@
 
 SYNTAX_DICT = {
     'allowed_starts_special_commands': {
-        'help' : [],
-        '.docs' : [],
-        'quit' : [],
-        '.show' : [],
-        '.json_compact' : [],
-        '.json_full' : [],
-        '.export_as_html' : [],
-        '.export_as_csv' : [],
-        '.export_as_gist' : [],
-        '.export_as_json' : [],
-        '.export_as_bar_chart' : [],
-        '.export_as_jupyter' : [],
-        '.export_as_gsheets' : [],
-        '.url' : [],
+        '/help' : [],
+        '/docs' : [],
+        '/quit' : [],
+        '/show' : [],
+        '/json_compact' : [],
+        '/json_full' : [],
+        '/export_as_html' : [],
+        '/export_as_csv' : [],
+        '/export_as_gist' : [],
+        '/export_as_json' : [],
+        '/export_as_bar_chart' : [],
+        '/export_as_jupyter' : [],
+        '/export_as_gsheets' : [],
+        '/url' : [],
     },
     'allowed_starts_dsl_query': {
         'search': [],

dimcli/repl/autocompletion.py

@@ -72,7 +72,7 @@ def get_completions(self, document, complete_event):
                 entity = G.entity_type_for_source_facet(source, test_return_obj)
                 candidates = G.fields_for_entity_from_source_facet(source, test_return_obj)
 
-        elif line_last_word(line_minus_current) in [".docs"]:
+        elif line_last_word(line_minus_current) in ["/docs"]:
             candidates = G.sources() + G.entities()
 
         elif line_last_word(line_minus_current) in ["describe"]:

dimcli/repl/repl.py

@@ -43,35 +43,35 @@
 
 HELP_MESSAGE =  """COMMANDS LIST
 ====================
-All special commands start with '.'
+All special commands start with '/'
 ----
->>> help: show this help message
+>>> /help: show this help message
 ----
->>> <tab>:  autocomplete. 
+>>> <tab>:  autocomplete.
 ----
->>> .docs: print out documentation for DSL data objects.  
->>> .export_as_json: save results from last query as JSON file.  
->>> .export_as_csv: save results from last query as CSV file.  
->>> .export_as_gist: save results from last query as Github GIST.  
->>> .export_as_html: save results from last query as HTML file. 
->>> .export_as_bar_chart: save results from last query as Plotly bar chart. 
->>> .export_as_jupyter: save results from last query as Jupyter notebook. 
->>> .export_as_gsheets: save results from last query as Google Sheets (requires gspread credentials). 
->>> .show [optional: N]: print N results from last query, trying to build URLs for objects. Default N=10.
->>> .json_compact: print results of last query as single-line JSON. 
->>> .json_full: print results of last query as formatted JSON.
->>> .url: resolve a Dimensions ID into a public URL.
+>>> /docs: print out documentation for DSL data objects.
+>>> /export_as_json: save results from last query as JSON file.
+>>> /export_as_csv: save results from last query as CSV file.
+>>> /export_as_gist: save results from last query as Github GIST.
+>>> /export_as_html: save results from last query as HTML file.
+>>> /export_as_bar_chart: save results from last query as Plotly bar chart.
+>>> /export_as_jupyter: save results from last query as Jupyter notebook.
+>>> /export_as_gsheets: save results from last query as Google Sheets (requires gspread credentials).
+>>> /show [optional: N]: print N results from last query, trying to build URLs for objects. Default N=10.
+>>> /json_compact: print results of last query as single-line JSON.
+>>> /json_full: print results of last query as formatted JSON.
+>>> /url: resolve a Dimensions ID into a public URL.
 ----
->>> <Ctrl-o>: search docs online. 
+>>> <Ctrl-o>: search docs online (type a search query first).
 >>> <Ctrl-c>: abort query.
 >>> <Ctrl-d>: exit console.
 ----
->>> quit: exit console
+>>> /quit: exit console
 ====================
 *ABOUT AUTOCOMPLETE*
 Including a space between query elements (= keywords and operators) leads to better autocomplete results."""
 
-WELCOME_MESSAGE = "Welcome! Type help for more info."
+WELCOME_MESSAGE = "Welcome! Type /help for more info."
 # WELCOME_MESSAGE = "Welcome! Type help for more info. Ready to query endpoint: %s"
 
 
@@ -105,16 +105,16 @@ def __init__(self, dslclient, databuffer):
 
     def handle(self, text):
         "process text and delegate"
-        if text.replace("\n", "").strip().startswith(".show") or text.replace("\n", "").strip().startswith(".json"):
+        if text.replace("\n", "").strip().startswith("/show") or text.replace("\n", "").strip().startswith("/json"):
             self.show(text.replace("\n", "").strip())
 
-        elif text.replace("\n", "").strip().startswith(".export"):
+        elif text.replace("\n", "").strip().startswith("/export"):
             self.export(text.replace("\n", "").strip())
 
-        elif text.replace("\n", "").strip().startswith(".docs"):
+        elif text.replace("\n", "").strip().startswith("/docs"):
             self.docs_full(text.replace("\n", "").strip())
 
-        elif text.replace("\n", "").strip().startswith(".url"):
+        elif text.replace("\n", "").strip().startswith("/url"):
             self.url_resolver(text.replace("\n", "").strip())
 
         else:
@@ -125,7 +125,7 @@ def url_resolver(self, text):
         """
         turn an ID into a Dimensions URL - print out results
         """
-        text = text.replace(".url", "").strip()
+        text = text.replace("/url", "").strip()
         if len(text) > 0:
             print_dimensions_url(text)
 
@@ -163,7 +163,7 @@ def docs_full(self, text):
         """
         print out docs infos from 'describe' API
         """
-        text = text.replace(".docs", "").split()
+        text = text.replace("/docs", "").split()
         if len(text) > 0:
             if text[0] in G.entities():
                 res = self.dsl.query(f"describe entity {text[0]}")
@@ -221,25 +221,25 @@ def export(self, text):
         CONNECTION = get_global_connection()
         api_endpoint = CONNECTION.url
         # cases
-        if text == ".export_as_html":
+        if text == "/export_as_html":
             export_json_html(jsondata, query, api_endpoint, USER_EXPORTS_DIR)
 
-        elif text == ".export_as_gist":
+        elif text == "/export_as_gist":
             export_gist(jsondata, query, api_endpoint)
 
-        elif text == ".export_as_csv":
+        elif text == "/export_as_csv":
             export_json_csv(jsondata, query, USER_EXPORTS_DIR)
 
-        elif text == ".export_as_json":
+        elif text == "/export_as_json":
             export_json_json(jsondata, query, USER_EXPORTS_DIR)
 
-        elif text == ".export_as_bar_chart":
+        elif text == "/export_as_bar_chart":
             export_as_bar_chart(jsondata, query, USER_EXPORTS_DIR)
 
-        elif text == ".export_as_jupyter":
+        elif text == "/export_as_jupyter":
             export_as_jupyter(jsondata, query, USER_EXPORTS_DIR)
 
-        elif text == ".export_as_gsheets":
+        elif text == "/export_as_gsheets":
             export_as_gsheets_wrapper(jsondata, query)
 
 
@@ -259,14 +259,14 @@ def show(self, text):
             print("Nothing to show - please run a search first.")
             return
         # cases
-        if text == ".json_compact":
+        if text == "/json_compact":
             print_json_compact(jsondata)
-        elif text == ".json_full":
+        elif text == "/json_full":
             print_json_full(jsondata)
         else:
-            # must be a simple ".show" + X command
+            # must be a simple "/show" + X command
             try:
-                no = text.replace(".show", "").strip()
+                no = text.replace("/show", "").strip()
                 slice_no = int(no)
             except ValueError:
                 slice_no = DEFAULT_NO_RECORDS
@@ -333,9 +333,9 @@ def run(instance="live"):
         else:
             if text.strip() == "":
                 continue
-            elif text == "quit":
+            elif text == "/quit":
                 break
-            elif text == "help":
+            elif text == "/help":
                 click.secho(HELP_MESSAGE, dim=True)
                 continue
             # cm = CommandsManager(CLIENT,databuffer)

dimcli/utils/repl_utils.py

@@ -667,8 +667,7 @@ def preview_results(jsondata, maxitems=10):
                             click.style(str(row)))
             if len(jsondata[key]) > maxitems:
                 click.secho("---", dim=True)
-                click.secho(f"Note: {maxitems} of {len(jsondata[key])} results shown. Use '.show <number>' to view more.", dim=True)
-
+                click.secho(f"Note: {maxitems} of {len(jsondata[key])} results shown. Use '/show <number>' to view more.", dim=True)
 
 
 def print_json_compact(jsondata):