Package: guix-patches;
Reported by: Jesse <jgibbons2357 <at> gmail.com>
Date: Mon, 20 Sep 2021 22:26:02 UTC
Severity: normal
Tags: patch
To reply to this bug, email your comments to 50708 AT debbugs.gnu.org.
Toggle the display of automated, internal messages from the tracker.
View this report as an mbox folder, status mbox, maintainer mbox
guix-patches <at> gnu.org:bug#50708; Package guix-patches.
(Mon, 20 Sep 2021 22:26:02 GMT) Full text and rfc822 format available.Jesse <jgibbons2357 <at> gmail.com>:guix-patches <at> gnu.org.
(Mon, 20 Sep 2021 22:26:02 GMT) Full text and rfc822 format available.Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
From: Jesse <jgibbons2357 <at> gmail.com> To: guix-patches <at> gnu.org Subject: [PATCH] gnu: web: Add jupyter-service Date: Mon, 20 Sep 2021 16:25:42 -0600
[Message part 1 (text/plain, inline)]
The attached patch adds the jupyter service, which automatically starts a jupyter notebook server at startup. It also includes documentation for the Jupyter service. Go ahead, tell me how awful it is. -Jesse
[0001-gnu-web-Add-jupyter-service.patch (text/plain, attachment)]
guix-patches <at> gnu.org:bug#50708; Package guix-patches.
(Wed, 22 Sep 2021 01:27:01 GMT) Full text and rfc822 format available.Message #8 received at 50708 <at> debbugs.gnu.org (full text, mbox):
From: Jesse <jgibbons2357 <at> gmail.com> To: 50708 <at> debbugs.gnu.org Subject: Re: bug#50708: [PATCH] gnu: web: Add jupyter-service Date: Tue, 21 Sep 2021 19:26:11 -0600
[Message part 1 (text/plain, inline)]
Attached is an updated patch.
[0001-gnu-web-Add-jupyter-service.patch (text/plain, attachment)]
guix-patches <at> gnu.org:bug#50708; Package guix-patches.
(Thu, 23 Sep 2021 02:21:02 GMT) Full text and rfc822 format available.Message #11 received at 50708 <at> debbugs.gnu.org (full text, mbox):
From: Maxim Cournoyer <maxim.cournoyer <at> gmail.com> To: Jesse <jgibbons2357 <at> gmail.com> Cc: 50708 <at> debbugs.gnu.org Subject: Re: bug#50708: [PATCH] gnu: web: Add jupyter-service Date: Wed, 22 Sep 2021 22:19:56 -0400
Hello Jesse,
Jesse <jgibbons2357 <at> gmail.com> writes:
> Attached is an updated patch.
>
> From d264da0811480a8d2acd5e73f58d320e15bfa9f3 Mon Sep 17 00:00:00 2001
> From: Jesse <gib19014 <at> byui.edu>
> Date: Mon, 20 Sep 2021 16:01:22 -0600
> Subject: [PATCH] gnu: web: Add jupyter-service
>
> * gnu/services/web.scm (gitile-service-type): New variable.
> * doc/guix.texi (Version Control Services): Document it.
> ---
> doc/guix.texi | 52 +++++++++++++++++++
> gnu/services/web.scm | 120 +++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 172 insertions(+)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 6436e83a7c..0f8aaca413 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -26197,6 +26197,58 @@ The file which should store the logging output of Agate.
> @end table
> @end deftp
>
> +@cindex jupyter
> +The Jupyter Notebook is a web application that allows you to create
> +and share documents that contain live code, equations, visualizations
> +and explanatory text. Uses include: data cleaning and transformation,
> +numerical simulation, statistical modeling, machine learning and much
> +more.
> +
> +@deffn (Scheme Variable) jupyter-service-type
> +This is the type of the agate service, whose value should be an
^
Agate
I'm a bit confused by this service referring to Agate; seems it'd be
clearer for the neophyte to simply refer to Jupyter in its place, even
if it's technically an Agate server powering it?
> +@code{jupyter-service-type} object, as in this example:
> +
> +@lisp
> +(service jupyter-service-type
> + (jupyter-configuration
> + (log-file "/var/log/jupyter.log")
> + (server-config
> + (kernels
> + (list jupyter-guile-kernel)))))
> +
> +@end lisp
I'd put the (list jupyter-guile-kernel) on the same line as (kernels
...)
> +The example above tells the the Jupyter service to provide the
^ typo
> +@code{jupyter-guile-kernel} as an optional kernel.
> +@end deffn
> +
> +@deftp {Data Type} jupyter-configuration
> +Data type representing the configuration of Agate.
> +
> +@table @asis
> +@item @code{jupyter-package} (default: @code{jupyter})
> +The jupyter package to use.
^
Jupyter
I'd capitalize Jupyter in other places as well where it's not decorated
as a command or code, since it's a proper name.
> +
> +@item @code{kernels} (default: @code{'()}
> +A list of kernel packages to use with the jupyter service.
^ here
> +
> +@item @code{root-dir} (default: @file{"/var/lib/jupyter/notebooks"})
> +The directory where the jupyter server looks for jupyter notebooks.
^ and here
> +@item @code{log-file} (default: @code{#f})
> +The location of the log file. If #f is given, no log is produced.
>
> +@item @code{shell} (default: @code{(file-append bash "/bin/bash")}
> +The location of the shell used when starting a web terminal (if it is configured to allow terminals).
> +
> +@item @code{server-config} (default: @code{#f})
> +A file contianing the jupyter server's config file. If @code{#f} is given, an empty file is produced,
^ containing
> and the default settings are used.
> +
> +@end table
> +@end deftp
> +
> +
> @node Certificate Services
> @subsection Certificate Services
>
> diff --git a/gnu/services/web.scm b/gnu/services/web.scm
> index 6a093cf4e4..2d2946f7a7 100644
> --- a/gnu/services/web.scm
> +++ b/gnu/services/web.scm
> @@ -15,6 +15,7 @@
> ;;; Copyright © 2020 Arun Isaac <arunisaac <at> systemreboot.net>
> ;;; Copyright © 2020 Oleg Pykhalov <go.wigust <at> gmail.com>
> ;;; Copyright © 2020, 2021 Alexandru-Sergiu Marton <brown121407 <at> posteo.ro>
> +;;; Copyright © 2020, 2021 Jesse Gibbons <jgibbons2357+guix <at> gmail.com>
> ;;;
> ;;; This file is part of GNU Guix.
> ;;;
> @@ -41,11 +42,13 @@
> #:use-module (gnu system shadow)
> #:use-module (gnu packages admin)
> #:use-module (gnu packages base)
> + #:use-module (gnu packages bash)
> #:use-module (gnu packages databases)
> #:use-module (gnu packages web)
> #:use-module (gnu packages patchutils)
> #:use-module (gnu packages php)
> #:use-module (gnu packages python)
> + #:use-module (gnu packages python-xyz)
> #:use-module (gnu packages gnupg)
> #:use-module (gnu packages guile)
> #:use-module (gnu packages logging)
> @@ -91,6 +94,8 @@
>
> httpd-service-type
>
> + jupyter-configuration
> +
> nginx-configuration
> nginx-configuration?
> nginx-configuration-nginx
> @@ -1994,3 +1999,118 @@ root=/srv/gemini
> (service-extension shepherd-root-service-type
> agate-shepherd-service)))
> (default-value (agate-configuration))))
> +
> +
> +;;; Jupyter configuration
> +;;; Jupyter server configuration
> +;;; -> includes a list of kernels to allow in the jupyter server
> +;;; -> includes a list of configuration options specifically for the jupyter server
> +;;; --> These options can be concatenated to a python file
> +;;; --> Nested alist
> +;;; ---> '((NotebookApp (allow-remote-access #t))) -> "c.NotebookApp.allow_remote_access = True"
> +;;; -> Include some settings specifying how to run the daemon
> +;;; --> location of log file
> +;;; --> If a console should be allowed, the location of the shell to be used.
> +;;; --> The package containing the jupyter server itself, default
> jupyter
What is the meaning of the arrows in the above comment? It seems to me
that they were meant to be used during development, not in the final
result? Otherwise, the types of the fields could be self-documented and
controlled by the use of the 'define-configuration' procedure and
friends from the (gnu services configuration) module.
> +(define-public default-jupyter-config "#")
> +
> +(define-record-type* <jupyter-configuration> jupyter-configuration
> + this-jupyter-configuration jupyter-configuration?
> + (jupyter-package jupyter-configuration-jupyter-package
> + (default jupyter))
> + (kernels jupyter-configuration-kernels
> + (default '()))
> + (root-dir jupyter-configuration-root-dir
> + (default "/var/lib/jupyter/notebooks"))
> + (log-file jupyter-configuration-log-file
> + (default #f))
> + (shell jupyter-configuration-shell
> + (default (file-append bash "/bin/bash")))
> + (server-config jupyter-configuration-server-config
> + (default #f))); TODO: Make configuration DSL.
> +
> +
> +(define (search-path-string search-path-pair)
> + (string-append (search-path-specification-variable (car search-path-pair))
> + "="
> + (cdr search-path-pair)))
> +
> +;;;TODO: Add actions to list jupyter servers, change passwords, etc.
> +(define (jupyter-shepherd-service config)
> + (list (shepherd-service
> + (provision '(jupyter)) ;TODO: Add magic to allow multiple Jupyter servers
> + (requirement '(loopback))
> + (start #~(make-forkexec-constructor
> + (list "/run/current-system/profile/bin/jupyter"
> + "notebook"
> + (string-append "--config="
> + #$(or (jupyter-configuration-server-config config)
> + (plain-file "jupyter_notebook_config.py"
> + default-jupyter-config))
> + #$(jupyter-configuration-root-dir config)))
> + #:user "jupyter"
> + #:group "jupyter"
> + #:environment-variables ; TODO use search-paths magic instead of hard-coding these things.
> + (list "GI_TYPELIB_PATH=/run/current-system/profile/lib/girepository-1.0"
> + "GUILE_LOAD_COMPILED_PATH=/run/current-system/profile/lib/guile/3.0/site-ccache:/run/current-system/profile/share/guile/site/3.0"
> + "GUILE_LOAD_PATH=/run/current-system/profile/share/guile/site/3.0"
> + "HOME=/var/lib/jupyter"
> + "JUPYTER_PATH=/run/current-system/profile/share/jupyter"
> + "PATH=/run/current-system/profile/bin:/run/current-system/profile/sbin"
> + "PYTHONPATH=/run/current-system/profile/lib/python3.8/site-packages"
> + "R_LIBS_SITE=/run/current-system/profile/site-library/"
> + "TEXMF=/run/current-system/profile/share/texmf-dist"
> + "TEXMFCNF=/run/current-system/profile//share/texmf-dist/web2c"
^
extra slash
> + "XDG_DATA_DIRS=/run/current-system/profile/share")
> +
Hmm. Would it work if search paths were set on the 'jupyter' package
instead? The above is too fragile, with hard coded versions baked in.
> + #:directory #$(jupyter-configuration-root-dir config)
> + #:log-file #$(jupyter-configuration-log-file config)))
> + (stop #~(make-kill-destructor))
> + (documentation "Runs a Jupyter Notebook server. A Jupyter Notebook is
^ Use two
spaces after period.
>a web application that allows you to create and share documents that contain live code, equations, visualizations, and explanatory text."))))
> +
> +(define (jupyter-account config)
> + (list
> + (user-account
> + (name "jupyter")
> + (group "jupyter")
> + (comment "Jupyter Notebook Server")
> + (home-directory "/var/lib/jupyter")
> + (shell (jupyter-configuration-shell config))
> + (system? #t))
> + (user-group
> + (name "jupyter")
> + (system? #t))))
> +
> +(define (jupyter-profile config)
> + (cons*
> + (jupyter-configuration-jupyter-package config)
> + (jupyter-configuration-kernels config)))
> +
> +(define (jupyter-activation config)
> + #~(begin
> + (let ((root-dir #$(jupyter-configuration-root-dir config))
> + (pw (getpwnam "jupyter")))
> + (unless (file-exists? root-dir)
> + (mkdir root-dir)
> + (chown root-dir (passwd:uid pw)
> + (passwd:gid pw))
> + (chmod root-dir #o700)))))
> +
> +;;; Jupyter service type
> +;;; -> Information vital to settinng up the server, like the port and accepted parameters
> +;;; -> list of kernels considered permissible.
> +;;; -> a shepherd service extension that runs the jupyter server
> +;;; --> shepherd service to list the running servers, set the password, etc.
> +;;; --> Make a log file only readable by root?
> +;;; -> an accounts service extension describing the user that runs the accounts
> +;;; --> group "jupyter"
Same comment as earlier.
> +(define-public jupyter-service-type
> + (service-type
> + (name "jupyter")
> + (extensions (list
> + (service-extension shepherd-root-service-type jupyter-shepherd-service)
> + (service-extension account-service-type jupyter-account)
> + (service-extension activation-service-type jupyter-activation)
> + (service-extension profile-service-type jupyter-profile)))
> + (description "Runs a Jupyter Notebook server. A Jupyter Notebook is a web application that allows you to create and share documents that contain live code, equations, visualizations, and explanatory text.")
> + (default-value (jupyter-configuration))))
I haven't tried it, but it looks promising. If we can find a better
solution than the hard coded version values in the environment variables
list, I think it'd be in good shape for inclusion, although a system
test would be a nice to have.
Thank you!
Maxim
guix-patches <at> gnu.org:bug#50708; Package guix-patches.
(Thu, 23 Sep 2021 02:23:02 GMT) Full text and rfc822 format available.Message #14 received at 50708 <at> debbugs.gnu.org (full text, mbox):
From: Jesse <jgibbons2357 <at> gmail.com> To: 50708 <at> debbugs.gnu.org Subject: Re: bug#50708: [PATCH] gnu: web: Add jupyter-service Date: Wed, 22 Sep 2021 20:22:12 -0600
[Message part 1 (text/plain, inline)]
Attached is yet another updated patch fixing a mistake in the added documentation. On 9/21/21 7:26 PM, Jesse wrote: > Attached is an updated patch.
[0001-gnu-web-Add-jupyter-service.patch (text/plain, attachment)]
guix-patches <at> gnu.org:bug#50708; Package guix-patches.
(Thu, 23 Sep 2021 03:13:02 GMT) Full text and rfc822 format available.Message #17 received at 50708 <at> debbugs.gnu.org (full text, mbox):
From: Jesse <jgibbons2357 <at> gmail.com> To: Maxim Cournoyer <maxim.cournoyer <at> gmail.com> Cc: 50708 <at> debbugs.gnu.org Subject: Re: bug#50708: [PATCH] gnu: web: Add jupyter-service Date: Wed, 22 Sep 2021 21:11:52 -0600
[Message part 1 (text/plain, inline)]
Attached is a patch that takes into account your feedback. On 9/22/21 8:19 PM, Maxim Cournoyer wrote: > Hello Jesse, > > Jesse <jgibbons2357 <at> gmail.com> writes: ... > + #:environment-variables ; TODO use search-paths magic instead of hard-coding these things. > + (list "GI_TYPELIB_PATH=/run/current-system/profile/lib/girepository-1.0" > + "GUILE_LOAD_COMPILED_PATH=/run/current-system/profile/lib/guile/3.0/site-ccache:/run/current-system/profile/share/guile/site/3.0" > + "GUILE_LOAD_PATH=/run/current-system/profile/share/guile/site/3.0" > + "HOME=/var/lib/jupyter" > + "JUPYTER_PATH=/run/current-system/profile/share/jupyter" > + "PATH=/run/current-system/profile/bin:/run/current-system/profile/sbin" > + "PYTHONPATH=/run/current-system/profile/lib/python3.8/site-packages" > + "R_LIBS_SITE=/run/current-system/profile/site-library/" > + "TEXMF=/run/current-system/profile/share/texmf-dist" > + "TEXMFCNF=/run/current-system/profile//share/texmf-dist/web2c" > >> + "XDG_DATA_DIRS=/run/current-system/profile/share") >> + > Hmm. Would it work if search paths were set on the 'jupyter' package > instead? The above is too fragile, with hard coded versions baked in. > > ... > I haven't tried it, but it looks promising. If we can find a better > solution than the hard coded version values in the environment variables > list, I think it'd be in good shape for inclusion, although a system > test would be a nice to have. > > Thank you! > > Maxim The weird thing about this particular service is it is more useful with libraries Jupyter and the kernels are not dependent on. This part is leftover from when I wrote it several months ago for a home server. (I actually used this service to work on notebooks using the Guile kernel working with sqlite and to try the other kernels.) I found that it couldn't find the packages I need and the web shell was broken, so I settled for hard-coding these variables until I could find time to fix them. I included a TODO with an idea I have not yet implemented: use the search-paths to give Jupyter the environment variables it needs the same way a profile sets up its search paths. I thought it might be a good idea to associate the service with its own profile for security reasons. This would also fix a bug where the Jupyter Notebook icon appears on the desktop but fails to start a new Jupyter server. Another idea I had is the service could be isolated in its own container with the network exposed and the home directory shared, but I have no idea how that would work or if it would even add more security. However, this could potentially allow multiple Jupyter services to run simultaneously on different ports. However, one problem is the resulting server might be unusable because the login information would be in a log file hidden in a container. I'll work on the search-paths idea and send an update when I'm done. I'm also open to other suggestions on how to fix the hard-coded values. I don't think this will be ready to merge until that problem is fixed, but I've attached the patch anyway for curious users who want to try it out. I would appreciate help implementing the container idea if it's feasible. -Jesse
[0001-gnu-web-Add-jupyter-service.patch (text/plain, attachment)]
guix-patches <at> gnu.org:bug#50708; Package guix-patches.
(Tue, 28 Sep 2021 19:18:01 GMT) Full text and rfc822 format available.Message #20 received at 50708 <at> debbugs.gnu.org (full text, mbox):
From: Xinglu Chen <public <at> yoctocell.xyz> To: Jesse <jgibbons2357 <at> gmail.com>, 50708 <at> debbugs.gnu.org Subject: Re: [bug#50708] [PATCH] gnu: web: Add jupyter-service Date: Tue, 28 Sep 2021 21:17:23 +0200
[Message part 1 (text/plain, inline)]
On Wed, Sep 22 2021, Jesse wrote:
> Attached is yet another updated patch fixing a mistake in the added
> documentation.
>
> On 9/21/21 7:26 PM, Jesse wrote:
>> Attached is an updated patch.
> From d264da0811480a8d2acd5e73f58d320e15bfa9f3 Mon Sep 17 00:00:00 2001
> From: Jesse <gib19014 <at> byui.edu>
> Date: Mon, 20 Sep 2021 16:01:22 -0600
> Subject: [PATCH] gnu: web: Add jupyter-service
>
> * gnu/services/web.scm (gitile-service-type): New variable.
> * doc/guix.texi (Version Control Services): Document it.
> ---
> doc/guix.texi | 52 +++++++++++++++++++
> gnu/services/web.scm | 120 +++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 172 insertions(+)
It would also be good to have a test for the service. You can look at
at (gnu tests ...) modules for some inspiration.
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 6436e83a7c..0f8aaca413 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -26197,6 +26197,58 @@ The file which should store the logging output of Agate.
> @end table
> @end deftp
>
> +@cindex jupyter
> +The Jupyter Notebook is a web application that allows you to create
> +and share documents that contain live code, equations, visualizations
> +and explanatory text. Uses include: data cleaning and transformation,
> +numerical simulation, statistical modeling, machine learning and much
> +more.
> +
> +@deffn (Scheme Variable) jupyter-service-type
> +This is the type of the agate service, whose value should be an
Agate service? The Jupyter service doesn’t seem to use Agate anywhere.
> +@code{jupyter-service-type} object, as in this example:
> +
> +@lisp
> +(service jupyter-service-type
> + (jupyter-configuration
> + (log-file "/var/log/jupyter.log")
> + (server-config
> + (kernels
> + (list jupyter-guile-kernel)))))
> +
> +@end lisp
The indentation looks incorrect. Also the trailing newline isn’t
necessary. Something like
--8<---------------cut here---------------start------------->8---
(service jupyter-service-type
(jupyter-configuration
(log-file "/var/log/jupyter.log")
(server-config
(kernels
(list jupyter-guile-kernel)))))
--8<---------------cut here---------------end--------------->8---
> +The example above tells the the Jupyter service to provide the
> +@code{jupyter-guile-kernel} as an optional kernel.
> +@end deffn
> +
> +@deftp {Data Type} jupyter-configuration
> +Data type representing the configuration of Agate.
s/Agate/Jupyter/ ?
> +@table @asis
> +@item @code{jupyter-package} (default: @code{jupyter})
> +The jupyter package to use.
“jupyter” should be capitalized.
> +
> +
> +@item @code{kernels} (default: @code{'()}
> +A list of kernel packages to use with the jupyter service.
> +
> +@item @code{root-dir} (default: @file{"/var/lib/jupyter/notebooks"})
> +The directory where the jupyter server looks for jupyter notebooks.
> +
> +@item @code{log-file} (default: @code{#f})
> +The location of the log file. If #f is given, no log is produced.
^
There should be two spaces after a period.
> +@item @code{shell} (default: @code{(file-append bash "/bin/bash")}
> +The location of the shell used when starting a web terminal (if it is configured to allow terminals).
Line should be kept at <=80 chars.
> +@item @code{server-config} (default: @code{#f})
> +A file contianing the jupyter server's config file. If @code{#f} is given, an empty file is produced, and the default settings are used.
Likewise (<=80 line length). What exactly does “A file” mean, do you
mean “file-like objects” (see “8.10 G-Expressions” in the manual)?
The example config doesn’t seem to provide anything “A file” either
--8<---------------cut here---------------start------------->8---
(service jupyter-service-type
(jupyter-configuration
(log-file "/var/log/jupyter.log")
(server-config
(kernels
(list jupyter-guile-kernel)))))
--8<---------------cut here---------------end--------------->8---
‘kernels’ doesn’t seem to be a procedure or macro, but rather a field in
the ‘jupyter-configuration’ record, so the example needs to be fixed as
well.
> +
> +@end table
> +@end deftp
> +
> +
> @node Certificate Services
> @subsection Certificate Services
>
> diff --git a/gnu/services/web.scm b/gnu/services/web.scm
> index 6a093cf4e4..2d2946f7a7 100644
> --- a/gnu/services/web.scm
> +++ b/gnu/services/web.scm
> @@ -15,6 +15,7 @@
> ;;; Copyright © 2020 Arun Isaac <arunisaac <at> systemreboot.net>
> ;;; Copyright © 2020 Oleg Pykhalov <go.wigust <at> gmail.com>
> ;;; Copyright © 2020, 2021 Alexandru-Sergiu Marton <brown121407 <at> posteo.ro>
> +;;; Copyright © 2020, 2021 Jesse Gibbons <jgibbons2357+guix <at> gmail.com>
> ;;;
> ;;; This file is part of GNU Guix.
> ;;;
> @@ -41,11 +42,13 @@
> #:use-module (gnu system shadow)
> #:use-module (gnu packages admin)
> #:use-module (gnu packages base)
> + #:use-module (gnu packages bash)
> #:use-module (gnu packages databases)
> #:use-module (gnu packages web)
> #:use-module (gnu packages patchutils)
> #:use-module (gnu packages php)
> #:use-module (gnu packages python)
> + #:use-module (gnu packages python-xyz)
> #:use-module (gnu packages gnupg)
> #:use-module (gnu packages guile)
> #:use-module (gnu packages logging)
> @@ -91,6 +94,8 @@
>
> httpd-service-type
>
> + jupyter-configuration
> +
> nginx-configuration
> nginx-configuration?
> nginx-configuration-nginx
> @@ -1994,3 +1999,118 @@ root=/srv/gemini
> (service-extension shepherd-root-service-type
> agate-shepherd-service)))
> (default-value (agate-configuration))))
> +
> +
> +;;; Jupyter configuration
> +;;; Jupyter server configuration
> +;;; -> includes a list of kernels to allow in the jupyter server
> +;;; -> includes a list of configuration options specifically for the jupyter server
> +;;; --> These options can be concatenated to a python file
> +;;; --> Nested alist
> +;;; ---> '((NotebookApp (allow-remote-access #t))) -> "c.NotebookApp.allow_remote_access = True"
> +;;; -> Include some settings specifying how to run the daemon
> +;;; --> location of log file
> +;;; --> If a console should be allowed, the location of the shell to be used.
> +;;; --> The package containing the jupyter server itself, default jupyter
What do these arrows mean? Also, keep lines <=80 chars wide.
> +(define-public default-jupyter-config "#")
Does the default config have to contain a “#”, can’t it just be an empty
string?
> +
> +(define-record-type* <jupyter-configuration> jupyter-configuration
> + this-jupyter-configuration jupyter-configuration?
> + (jupyter-package jupyter-configuration-jupyter-package
> + (default jupyter))
> + (kernels jupyter-configuration-kernels
> + (default '()))
> + (root-dir jupyter-configuration-root-dir
> + (default "/var/lib/jupyter/notebooks"))
> + (log-file jupyter-configuration-log-file
> + (default #f))
I think it would be good to have a log file by default.
> + (shell jupyter-configuration-shell
> + (default (file-append bash "/bin/bash")))
> + (server-config jupyter-configuration-server-config
> + (default #f))); TODO: Make configuration DSL.
> +
> +
> +(define (search-path-string search-path-pair)
> + (string-append (search-path-specification-variable (car search-path-pair))
> + "="
> + (cdr search-path-pair)))
Prefer ‘match’ over ‘car’ and ‘cdr’.
> +
> +;;;TODO: Add actions to list jupyter servers, change passwords, etc.
> +(define (jupyter-shepherd-service config)
> + (list (shepherd-service
> + (provision '(jupyter)) ;TODO: Add magic to allow multiple Jupyter servers
> + (requirement '(loopback))
> + (start #~(make-forkexec-constructor
> + (list "/run/current-system/profile/bin/jupyter"
> + "notebook"
> + (string-append "--config="
> + #$(or (jupyter-configuration-server-config config)
> + (plain-file "jupyter_notebook_config.py"
> + default-jupyter-config))
> + #$(jupyter-configuration-root-dir config)))
Prefer ‘match’ instead of using accessor procedures. Something like
--8<---------------cut here---------------start------------->8---
(match config
(($ <jupyter-configuration> _ _ root-dir log-file _ server-config)
(list (shepherd-service ...))))
--8<---------------cut here---------------end--------------->8---
> + #:user "jupyter"
> + #:group "jupyter"
> + #:environment-variables ; TODO use search-paths magic instead of hard-coding these things.
> + (list "GI_TYPELIB_PATH=/run/current-system/profile/lib/girepository-1.0"
> + "GUILE_LOAD_COMPILED_PATH=/run/current-system/profile/lib/guile/3.0/site-ccache:/run/current-system/profile/share/guile/site/3.0"
> + "GUILE_LOAD_PATH=/run/current-system/profile/share/guile/site/3.0"
> + "HOME=/var/lib/jupyter"
> + "JUPYTER_PATH=/run/current-system/profile/share/jupyter"
> + "PATH=/run/current-system/profile/bin:/run/current-system/profile/sbin"
> + "PYTHONPATH=/run/current-system/profile/lib/python3.8/site-packages"
> + "R_LIBS_SITE=/run/current-system/profile/site-library/"
> + "TEXMF=/run/current-system/profile/share/texmf-dist"
> + "TEXMFCNF=/run/current-system/profile//share/texmf-dist/web2c"
> + "XDG_DATA_DIRS=/run/current-system/profile/share")
> +
> + #:directory #$(jupyter-configuration-root-dir config)
> + #:log-file #$(jupyter-configuration-log-file config)))
> + (stop #~(make-kill-destructor))
> + (documentation "Runs a Jupyter Notebook server. A Jupyter Notebook is a web application that allows you to create and share documents that contain live code, equations, visualizations, and explanatory text."))))
Watch the line length! :-)
> +
> +(define (jupyter-account config)
> + (list
> + (user-account
> + (name "jupyter")
> + (group "jupyter")
> + (comment "Jupyter Notebook Server")
> + (home-directory "/var/lib/jupyter")
> + (shell (jupyter-configuration-shell config))
> + (system? #t))
> + (user-group
> + (name "jupyter")
> + (system? #t))))
> +
> +(define (jupyter-profile config)
> + (cons*
> + (jupyter-configuration-jupyter-package config)
> + (jupyter-configuration-kernels config)))
Prefer ‘match’ instead of using accessor procedures.
> +
> +(define (jupyter-activation config)
> + #~(begin
> + (let ((root-dir #$(jupyter-configuration-root-dir config))
> + (pw (getpwnam "jupyter")))
> + (unless (file-exists? root-dir)
> + (mkdir root-dir)
> + (chown root-dir (passwd:uid pw)
> + (passwd:gid pw))
> + (chmod root-dir #o700)))))
> +
> +;;; Jupyter service type
> +;;; -> Information vital to settinng up the server, like the port and accepted parameters
> +;;; -> list of kernels considered permissible.
> +;;; -> a shepherd service extension that runs the jupyter server
> +;;; --> shepherd service to list the running servers, set the password, etc.
> +;;; --> Make a log file only readable by root?
> +;;; -> an accounts service extension describing the user that runs the accounts
> +;;; --> group "jupyter"
> +(define-public jupyter-service-type
> + (service-type
> + (name "jupyter")
> + (extensions (list
> + (service-extension shepherd-root-service-type jupyter-shepherd-service)
> + (service-extension account-service-type jupyter-account)
> + (service-extension activation-service-type jupyter-activation)
> + (service-extension profile-service-type jupyter-profile)))
> + (description "Runs a Jupyter Notebook server. A Jupyter Notebook is a web application that allows you to create and share documents that contain live code, equations, visualizations, and explanatory text.")
Keep lines <=80 chars, and use double-spacing.
> + (default-value (jupyter-configuration))))
> --
> 2.33.0
[signature.asc (application/pgp-signature, inline)]
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.