Merging to release 0.1.0 (#19)

* Minor improvements (#16)

* Starting work on Jupyterlite build of icortex

* Changed metadata

* Minor

* Currently trying to fix jupyter_client import

* Kernel resources get installed

* Removed JupyterLite work for now because it's not as straightforward as expected

* Bumped to version 0.1.0 to conform standards

* Migrate prompt parsing to magic commands (#18)

* Replaced / and // with magic commands %p and %icortex

* Execute generated code with InteractiveShell.run_cell()

* Cell outputs are saved to ICortexHistory

* Minor

Author: osolmaz

.gitignore

@@ -153,3 +153,4 @@ lite/jupyterlite-icortex/style/icortex.png
 lite/jupyterlite-icortex/LICENSE
 node_modules/
 *.tsbuildinfo
+*_backup

README.md

@@ -8,9 +8,11 @@ ICortex is a [Jupyter kernel](https://jupyter-client.readthedocs.io/en/latest/ke
 
 https://user-images.githubusercontent.com/2453968/196814906-1a0de2a1-27a7-4aec-a960-0eb21fbe2879.mp4
 
+TODO: Prompts are given using the %prompt magic now, update the video accordingly
+
 It is ...
 
-- a drop-in replacement for the IPython kernel. Prompts start with a forward slash `/`—otherwise the line is treated as regular Python code.
+- a drop-in replacement for the IPython kernel. Prompts can be executed with the [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html) `%prompt` or `%p` for short.
 - an interface for [Natural Language Programming](https://en.wikipedia.org/wiki/Natural-language_programming) interface—prompts written in plain English automatically generate Python code which can then be executed globally.
 - interactive—install missing packages directly, decide whether to execute the generated code or not, and so on, directly in the Jupyter Notebook cell.
 - open source and fully extensible—if you think we are missing a model or an API, you can request it by creating an issue, or implement it yourself by subclassing `ServiceBase` under [`icortex/services`](icortex/services).
@@ -40,7 +42,7 @@ icortex init
 Alternatively, you can initialize directly in a Jupyter Notebook ([instructions on how to start JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html)):
 
 ```
-//init
+%icortex init
 ```
 
 The shell will then instruct you step by step and create a configuration file `icortex.toml` in the current directory.
@@ -65,10 +67,10 @@ You can also try out different services e.g. OpenAI's Codex API, if you have acc
 
 ### Executing prompts
 
-To execute a prompt with ICortex, use the `/` character (forward slash, also used to denote division) as a prefix. Copy and paste the following prompt into a cell and try to run it:
+To execute a prompt with ICortex, use the `%prompt` [magic command](https://ipython.readthedocs.io/en/stable/interactive/magics.html) (or `%p` for short) as a prefix. Copy and paste the following prompt into a cell and try to run it:
 
 ```
-/print Hello World. Then print the Fibonacci numbers till 100
+%p print Hello World. Then print the Fibonacci numbers till 100
 ```
 
 Depending on the response, you should see an output similar to the following:
@@ -87,7 +89,7 @@ Hello World.
 You can also specify variables or options with command line flags, e.g. to auto-install packages, auto-execute the returned code and so on. To see the complete list of variables for your chosen service, run:
 
 ```
-/help
+%help
 ```
 
 ### Using ICortex CLI
@@ -106,7 +108,7 @@ icortex service help
 
 ### Accessing ICortex CLI inside Jupyter
 
-You can still access the `icortex` CLI in a Jupyter Notebook or shell by using the prefix `//`. For example running the following in the terminal switches to a local HuggingFace model:
+You can still access the `icortex` CLI in a Jupyter Notebook or shell by using the magic command `%icortex`. For example running the following in the terminal switches to a local HuggingFace model:
 
 ```
 icortex service set huggingface
@@ -115,7 +117,7 @@ icortex service set huggingface
 To do the same in a Jupyter Notebook, you can run
 
 ```
-//service set huggingface
+%icortex service set huggingface
 ```
 
 in a cell, which initializes and switches to the new service directly in your Jupyter session.

docs/source/specification.rst

@@ -0,0 +1,5 @@
+
+ICortex Specification
+=====================
+
+Some stuff

icortex/__init__.py

@@ -1,6 +1,5 @@
-from icortex.kernel import ICortexKernel, print_help, get_icortex_kernel
+from icortex.kernel import ICortexKernel, print_service_help, get_icortex_kernel
 
-# from icortex.cli import set_icortex_service, eval_cli
 import icortex.services
 import importlib.metadata
 

icortex/cli.py

@@ -2,20 +2,11 @@
 import shlex
 import sys
 import argparse
-from jupyter_console.app import ZMQTerminalIPythonApp
 from icortex.services import get_available_services
 from icortex.defaults import DEFAULT_ICORTEX_CONFIG_PATH
-from icortex.install import is_kernel_installed, main as install_kernel
+from icortex.kernel.install import is_kernel_installed, main as install_kernel
 from icortex.config import ICortexConfig
 
-# Jupyter devs did not make this easy
-# TODO: Make less hacky
-class ZMQTerminalICortexApp(ZMQTerminalIPythonApp):
-    def parse_command_line(self, argv=None):
-        argv = ["--kernel", "icortex"]
-        super(ZMQTerminalIPythonApp, self).parse_command_line(argv)
-        self.build_kernel_argv(self.extra_args)
-
 
 def get_parser(prog=None):
     service_names = get_available_services()
@@ -29,7 +20,7 @@ def get_parser(prog=None):
     # Initialize ICortex #
     ######################
 
-    # //init
+    # icortex init
     parser_init = subparsers.add_parser(
         "init",
         help="Initialize ICortex configuration in the current directory",
@@ -51,7 +42,7 @@ def get_parser(prog=None):
     # Shell related commands #
     ##########################
 
-    # //shell
+    # icortex shell
     parser_shell = subparsers.add_parser(
         "shell",
         help="Start ICortex shell",
@@ -62,7 +53,7 @@ def get_parser(prog=None):
     # Help #
     ########
 
-    # //help
+    # icortex help
     parser_help = subparsers.add_parser(
         "help",
         help="Print help",
@@ -73,7 +64,7 @@ def get_parser(prog=None):
     # Service related commands #
     ############################
 
-    # //service
+    # icortex service
     parser_service = subparsers.add_parser(
         "service",
         help="Set and configure code generation services",
@@ -84,7 +75,7 @@ def get_parser(prog=None):
         required=True,
     )
 
-    # //service set <service_name>
+    # icortex service set <service_name>
     parser_service_commands_set = parser_service_commands.add_parser(
         "set",
         help="Set the service to be used for code generation",
@@ -96,21 +87,21 @@ def get_parser(prog=None):
         help="Name of the service to be used for code generation",
     )
 
-    # //service show <service_name>
+    # icortex service show <service_name>
     parser_service_commands_show = parser_service_commands.add_parser(
         "show",
         help="Show current service",
         add_help=False,
     )
 
-    # //service help
+    # icortex service help
     parser_service_commands_help = parser_service_commands.add_parser(
         "help",
-        help="Print help for //service",
+        help="Print help for the current service",
         add_help=False,
     )
 
-    # //service set-var <variable_name> <variable_value>
+    # icortex service set-var <variable_name> <variable_value>
     parser_service_commands_set_var = parser_service_commands.add_parser(
         "set-var",
         help="Set a variable for the current service",
@@ -126,7 +117,7 @@ def get_parser(prog=None):
         help="New value for the variable",
     )
 
-    # //service init <service_name>
+    # icortex service init <service_name>
     # Used to re-spawn the config dialog if some config for the service
     # already exists
     parser_service_commands_init = parser_service_commands.add_parser(
@@ -150,7 +141,6 @@ def get_parser(prog=None):
 
 
 # def set_icortex_service(kernel, config_path=DEFAULT_ICORTEX_CONFIG_PATH):
-
 #     if kernel is not None:
 #         return ICortexConfig(DEFAULT_ICORTEX_CONFIG_PATH).set_service()
 #     return False
@@ -195,6 +185,7 @@ def main(argv=None, prog=None, kernel=None):
         parser.print_help()
     elif args.command == "shell" or args.command is None:
         from icortex.kernel import get_icortex_kernel
+        from icortex.kernel.app import ZMQTerminalICortexApp
 
         kernel = get_icortex_kernel()
         if kernel is None:
@@ -207,7 +198,7 @@ def main(argv=None, prog=None, kernel=None):
 def eval_cli(prompt: str):
     argv = shlex.split(prompt)
     try:
-        return main(argv=argv, prog="//")
+        return main(argv=argv, prog=r"%icortex")
     except SystemExit:
         return
 

icortex/context.py

@@ -10,17 +10,17 @@
     "metadata": {
         "kernelspec": {
             "display_name": "ICortex (Python 3)",
-            "language": "icortex",
+            "language": "python",
             "name": "icortex",
         },
         "language_info": {
-            "pygments_lexer": "icortex",
-            # "codemirror_mode": {"name": "ipython", "version": 3},
-            "file_extension": ".icx",
-            "mimetype": "text/x-icortex",
+            "pygments_lexer": "ipython3",
+            "codemirror_mode": {"name": "ipython", "version": 3},
+            "file_extension": ".py",
+            "mimetype": "text/x-python",
             "name": "icortex",
-            # "nbconvert_exporter": "python",
-            "pygments_lexer": "icortex",
+            "nbconvert_exporter": "python",
+            "pygments_lexer": "ipython3",
             "version": icortex_version,
             "python_version": platform.python_version(),
         },
@@ -48,8 +48,12 @@ def _check_init(self):
 
         self._dict = self.scope[DEFAULT_HISTORY_VAR]
 
-    def get_dict(self):
-        return deepcopy(self._dict)
+    def get_dict(self, omit_last_cell=False):
+        ret = deepcopy(self._dict)
+        if omit_last_cell:
+            if len(ret["cells"]) > 0:
+                del ret["cells"][-1]
+        return ret
 
     def add_code(self, code: str, outputs: t.List[t.Any]):
         self._check_init()

icortex/helper.py

@@ -8,23 +8,31 @@ def unescape(s) -> str:
 
 
 def is_prompt(input: str) -> bool:
-    return input.strip()[0] == "/"
+    return input.strip().split()[0] in [
+        r"%p",
+        r"%prompt",
+        r"%%prompt",
+        r"%%prompt",
+    ]
 
 
 def is_cli(input: str) -> bool:
-    return input.strip()[:2] == "//"
+    return input.strip().split()[0] == r"%icortex"
 
 
 def escape_quotes(s: str) -> str:
     return s.replace('"', r"\"").replace("'", r"\'")
 
 
 def extract_prompt(input: str) -> str:
-    return input.strip()[1:].strip()
+    tokens = input.strip().split(" ", 1)
+    if len(tokens) == 1:
+        return ""
+    else:
+        return tokens[1]
 
 
-def extract_cli(input: str) -> str:
-    return input.strip()[2:].strip()
+extract_cli = extract_prompt
 
 
 def yes_no_input(message: str, default=True) -> bool: