clojupyter.cmdline — clojupyter 0.3.6

-main clj

(-main & cmdline-args)

build-user-opts clj

(build-user-opts {{:keys [host jarfile] :as parse-opts} :options
                  :as parse-result})

CMDS clj

conda-build clj

(conda-build & args)

Clojupyter development cmdline command: Build a conda installation package for Clojupyter to be deployed in Anaconda cloud.

This command is intended for USE ONLY BY THE DEVELOPERS OF CLOJUPYTER for building the deployment packages allowing end-users to install generic Clojupyter kernels on their machine using conda install only. If you are not a Clojupyter developer you probably don't want to use this command.

The conda-build command is designed to be used on the platform of the package being built: You build a Linux package on a Linux machine, a MacOS package on a Mac, and a Windows package on a PC running Windows.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

PROCESS

1. The conda-build command spawns a conda process to perform the actual build in a temporary directory.

See PREREQUISITES for details.

EXECUTION TIME

Note that execution time for conda builds is considerable (often >60s) and that no output is produced until the process is complete - patience is required.

PREREQUISITE:

1. Conda installed and available on the path (executable: conda/conda.exe).

COMMAND ARGUMENTS:

• None

FLAG/OPTIONS:

-b, --build-num The conda build number. Must be a string representing a positive integer (lexically: a non-empty sequence of decimal digits).

-j, --jarfile. The jarfile to be included in the package. If not specified a default standalone jarfile is located, see local install for details.

The example below show a build on MacOS, builds on Linux and Windows are very similar.

EXAMPLE USE:

uname -rv 18.6.0 Darwin Kernel Version 18.6.0: Thu Apr 25 23:16:27 PDT 2019; root:xnu-4903.261.4~2/RELEASE_X86_64

conda --version conda 4.7.10

convert --version Version: ImageMagick 7.0.8-35 Q16 x86_64 2019-03-26 https://imagemagick.org Copyright: © 1999-2019 ImageMagick Studio LLC License: https://imagemagick.org/script/license.php Features: Cipher DPC HDRI Delegates (built-in): bzlib cairo fftw fontconfig freetype gvc jbig jng jp2 jpeg lzma pangocairo png rsvg tiff webp xml zlib

time clj -m clojupyter.cmdline conda-build -b99 Clojupyter v0.2.3-SNAPSHOT - Build Conda package

  Conda build completed successfully.
  Conda file output to ~/anaconda3/conda-bld/osx-64/clojupyter-0.2.3snapshot-99.tar.bz2

exit(0)

real 1m1.643s user 1m23.009s sys 0m3.301s

conda-link clj

(conda-link & args)

Clojupyter development cmdline command used by the conda package managment system.

This command is not intended for direct use, but is exclusively called by the conda package management system to install Clojupyter on the end-user machine.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

• None

FLAG/OPTIONS:

-p, --prefix Conda PREFIX, controls into which Conda environment to install Clojupyter.

-j, --jarfile. Jarfile to used for build. ONLY RELEVANT FOR TEST.

-n, --no-actions If specified: Do not make any changes to Conda environment. ONLY RELEVANT FOR TEST.

EXAMPLE USE: N/A

conda-unlink clj

(conda-unlink & args)

Clojupyter development cmdline command used by the conda package managment system.

This command is not intended for direct use, but is exclusively called by the conda package management system to remove Clojupyter from the end-user machine.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

• None

FLAG/OPTIONS:

-p, --prefix Conda PREFIX, controls into which Conda environment to install Clojupyter.

-n, --no-actions If specified: Do not make any changes to Conda environment. ONLY RELEVANT FOR TEST.

EXAMPLE USE: N/A

define-cmds clj macro

(define-cmds var defs)

DEPEND clj

DVL-CMDS clj

help clj

(help & args)

Clojupyter development cmdline command: Provides help for Clojupyter commands.

SUMMARY

• Use command 'list-commands' to see a list of available commands.
• Use command 'help <cmd>' to get documentation for individual commands.

EXAMPLE USE:

clj -m clojupyter.cmdline help version Clojupyter v0.2.3 - Help

  Use command 'list-commands' to see a list of available commands.

  Use command 'help <cmd>' to get documentation for individual commands.

  Docstring for 'version':

      Clojupyter cmdline command: Lists Clojupyter version information.

        Note that this function is designed to be used from the command line and is normally not called
        from the REPL although this does in fact work.  Note also that the function itself, if used
        directly from the REPL, returns a data structure containing a vector of strings which will be sent
        to standard output, whereas the cmdline command itself actually sends the strings to stdout.

        COMMAND ARGUMENTS:

          - None

        FLAG/OPTIONS:

          - None

        EXAMPLE USE:

          > clj -m clojupyter.cmdline version
          Clojupyter v0.2.3 - Version

                   #:version{:major 0,
                             :minor 2,
                             :incremental 3,
                             :qualifier "SNAPSHOT",
                             :lein-v-raw "cd18-DIRTY"}

          exit(0)
          >

exit(0)

install clj

(install & args)

Clojupyter cmdline command: Installs a Clojuputer kernel on the local host based on the contents of the code repository in the current directory.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout. The function receives its arguments as string values.

OPTIONS:

-h, --host: Install kernel such that it is available to all users on the host. If not specified installs the kernel in the Jupyter kernel directory of the current user. See platform documentation for details on the location of host-wide and user-specific Jupyter kernel directories.

-i, --ident: String to be used as identifier for the kernel.

-j, --jarfile: Filename of the jarfile, which must be a standalone jar containing Clojupyter, to be installed. If the not specified, uses any standalone jarfile found in the current directory or one of its subdirectories, provided a single such file is found. If zero or multiple standalone jarfiles are found an error is raised.

EXAMPLE USE:

clj -m clojupyter.cmdline install --ident mykernel -h Clojupyter v0.2.3 - Install Clojupyter

  Installed jar:      ~/lab/clojure/clojupyter/target/clojupyter-0.2.3-SNAPSHOT-standalone.jar
  Install directory:  /usr/local/share/jupyter/kernels/mykernel
  Kernel identifier:  mykernel

  Installation successful.

exit(0)

invoke-s*fn clj

(invoke-s*fn cmd-fn argc args error-exit-code usage-string)

list-commands clj

Clojupyter cmdline command: Lists the available Clojupyter cmdline commands. Note that this function is designed to be used from the command line and is normally not called from REPL (although this does in fact work).

COMMAND ARGUMENTS: None

FLAG/OPTIONS: None

EXAMPLE USE:

clj -m clojupyter.cmdline list-commands Clojupyter v0.2.3 - List commands

  Clojupyter commands:

     - help
     - install
     - list-commands
     - list-installs
     - list-installs-matching
     - remove-installs-matching
     - remove-install
     - version

  You can invoke Clojupyter commands like this:

     clj -m clojupyter.cmdline <command>

  or, if you have set up lein configuration, like this:

     lein clojupyter <command>

  See documentation for details.

exit(0)

list-dvl-commands clj

Clojupyter development cmdline command: Lists available developer-only commands.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

• None

FLAG/OPTIONS:

• None

EXAMPLE USE:

clj -m clojupyter.cmdline list-dvl-commands Clojupyter v0.2.3 - List commands

  Clojupyter commands:

     - conda-build
     - conda-link
     - conda-unlink
     - eval
     - getenv
     - list-dvl-commands
     - supported-os?

  You can invoke Clojupyter commands like this:

     clj -m clojupyter.cmdline <command>

  or, if you have set up lein configuration, like this:

     lein clojupyter <command>

  See documentation for details.

exit(0)

list-installs clj

Clojupyter cmdline command: Lists the Clojupyter kernels installed on the local host, giving the kernel identifier and kernel directory for each installed Clojupyter kernel. Non-Clojupyter kernels are not included.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS: None

OPTIONS: None

EXAMPLE USE:

clj -m clojupyter.cmdline list-installs Clojupyter v0.2.3 - All Clojupyter kernels

  |    IDENT |                                DIR |
  |----------+------------------------------------|
  |      abc |      ~/Library/Jupyter/kernels/abc |
  | mykernel | ~/Library/Jupyter/kernels/mykernel |
  |   test-1 |   ~/Library/Jupyter/kernels/test-1 |
  |   test-2 |   ~/Library/Jupyter/kernels/test-2 |
  |   test-3 |   ~/Library/Jupyter/kernels/test-3 |

exit(0)

list-installs-matching clj

(list-installs-matching & args)

Clojupyter cmdline command: Lists the Clojupyter kernels install on the local host whose identifier matches the mandatory string argument when interpreted as a regular expression.

It is an error if no string argument is provided, or if the provided string is not a legal regular expression as understood by clojure.core/re-pattern.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

1. Mandatory string representing a regular expression to be interpreted by clojure.core/re-pattern,

OPTIONS: None

EXAMPLE USE:

clj -m clojupyter.cmdline list-installs-matching test Clojupyter v0.2.3 - Clojupyter kernels matching the regular expression 'test'.

  |  IDENT |                              DIR |
  |--------+----------------------------------|
  | test-1 | ~/Library/Jupyter/kernels/test-1 |
  | test-2 | ~/Library/Jupyter/kernels/test-2 |
  | test-3 | ~/Library/Jupyter/kernels/test-3 |

exit(0)

parse-build-conda-cmdline clj

parse-install-local-cmdline clj

remove-install clj

(remove-install & args)

Clojupyter cmdline command: Removes a kernel by matching its kernel identifier to the string argument given.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

1. Kernel identifier of kernel.

FLAG/OPTIONS:

• None

EXAMPLE USE:

clj -m clojupyter.cmdline remove-install test-2 Clojupyter v0.2.3 - Remove kernel 'test-2'

  Step: Delete /Users/klaush/Library/Jupyter/kernels/test-2

  Status: Removals successfully completed.

exit(0)

remove-installs-matching clj

(remove-installs-matching & args)

Clojupyter cmdline command: Removes kernels by matching kernel identifiers to the regular expression given as argument.

The string must be a legal as interpreted by clojure.core/re-pattern.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

1. Mandatory string representing a regular expression to be interpreted by clojure.core/re-pattern,

FLAG/OPTIONS:

• None

EXAMPLE USE:

clj -m clojupyter.cmdline remove-installs-matching test Clojupyter v0.2.3 - Remove installs

  Step: Delete /Users/klaush/Library/Jupyter/kernels/test-2
  Step: Delete /Users/klaush/Library/Jupyter/kernels/test-1
  Step: Delete /Users/klaush/Library/Jupyter/kernels/test-3

  Status: Removals successfully completed.

exit(0)

s*argc-failure clj

(s*argc-failure usage-string exit-code)

s*conda-build clj

(s*conda-build & args)

s*conda-link clj

(s*conda-link & args)

s*conda-unlink clj

(s*conda-unlink & args)

supported-os? clj

Clojupyter development cmdline command: Lists information about the Operating System of the current machine. Used to test Cloupyter OS support, otherwise not very useful.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

• None

FLAG/OPTIONS:

• None

EXAMPLE USE:

clj -m clojupyter.cmdline supported-os? Clojupyter v0.2.3 - Operating System

  OS seems to be MACOS. Supported.

exit(0)

version clj

Clojupyter cmdline command: Lists Clojupyter version information.

Note that this function is designed to be used from the command line and is normally not called from the REPL although this does in fact work. Note also that the function itself, if used directly from the REPL, returns a data structure containing a vector of strings which will be sent to standard output, whereas the cmdline command itself actually sends the strings to stdout.

COMMAND ARGUMENTS:

• None

FLAG/OPTIONS:

• None

EXAMPLE USE:

clj -m clojupyter.cmdline version Clojupyter v0.2.3 - Version

       #:version{:major 0,
                 :minor 2,
                 :incremental 3,
                 :qualifier "SNAPSHOT",
                 :lein-v-raw "cd18-DIRTY"}

exit(0)