jupyternb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebfbba6b7604c84fa2c6ae94f613cfff2858668a
+  data.tar.gz: 9e7b56500cce2959b712c5773e95e89f145d9687
+SHA512:
+  metadata.gz: fa0e4011c768c38be623ebd3f2d9415761fcd724b056f3c213c124d623f841e2ea6a8bf3102e21139c55ac975dd7a4f6438b5732ac5aa16b834fb37585f0a1f0
+  data.tar.gz: 6886f076a095aa598e29fe9e73de2f15cf415e494db5a5af8f5f56ab8c16f7a13d8a25e91052bba527f71f8a9b93c58a4a9d3ee8e4b9406254b5ac6c473f2e90

data/.gitignore

@@ -0,0 +1,6 @@
+doc
+Gemfile.lock
+*.gem
+test
+*.swp
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Hermann Detz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+<Copyright (C) 2018 Hermann Detz>
+
+<This software may be modified and distributed under the terms>
+<of the MIT license.  See the LICENSE file for details.>
+
+# jupyternb
+
+This gem provides useful functions to generate Jupyter Notebooks,
+(formerly IPython Notebooks), from Ruby scripts.
+
+## Setup
+
+Add the gem to your Gemfile:
+
+    gem 'jupyternb', :path => "path-to/jupyternb"
+
+Update your gem list:
+
+    $ bundle install
+
+## Usage
+
+Currently, the only functionality is to generate .ipynb files. 
+A simple example is given in the following:
+
+```ruby
+module JupyterNB
+
+# Create a Jupyter Notebook Generator
+# The parameter defines the kernel used. Present options are :ruby or :python3.
+gen = Generator.new(:ruby)
+
+# Add some content cells (either multi-line strings or arrays of strings)
+gen.add_cell("markdown", "", "", "# Test header\nsome text\n## Second Header\nmore text")
+gen.add_cell("code", "", "", ["puts \"Hello World!\"","# Do something useful here"])
+
+# Simply print the output to the terminal
+puts gen.generate
+
+end
+```
+
+## Feedback & Contributions
+
+1. Fork it ( http://github.com/hermanndetz/middleman-gnuplot/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/jupyternb.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jupyternb"
+  spec.version       = JupyterNB::VERSION
+  spec.authors       = ["Hermann Detz"]
+  spec.email         = ["hermann.detz@gmail.com"]
+  spec.description   = <<-EOF 
+                       This gem provides useful functions to work with
+											 Jupyter Notebook files.
+                       EOF
+  spec.summary       = %q{Jupyter Notebook Tools}
+  spec.homepage      = "https://github.com/hermanndetz/jupyternb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end
+

data/lib/cell.rb

@@ -0,0 +1,96 @@
+# Copyright (C) 2018 Hermann Detz
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+
+require "helpers"
+
+module JupyterNB
+	class Cell
+		# Cell type e.g. "code" or "markdown"
+		@type = ""
+
+		# Array of strings (lines) for metadata
+		@metadata = []
+
+		# Array of strings (lines) for source
+		@source = []
+		
+		# Used in generate function, defined here because 
+		# needed by Helpers mixin
+		@indent = 1
+
+		# Execution count of code cell (hardcoded to 0 because it's just generated)
+		@count = 0
+
+		# Constructor
+		# @param [String] type defines the type of the cell (markdown, code, ...)
+		# @param metadata can be given as a string with linebreaks or as an array of strings
+		# @param outputs can be given as a string with linebreaks or as an array of strings		def add_cell(type,metadata,outputs,source)
+		# @param source can be given as a string with linebreaks or as an array of strings
+		def initialize(type, metadata, outputs, source)
+			@type = type
+			@metadata = read_parameter(metadata)
+			@source = read_parameter(source)
+			@count = 0
+		end
+
+		# Returns a string that contains an IPython Notebook cell
+		#
+		# The outputs field is not implemented yet. Should actually not be
+		# necessary for a pure generator.
+		# Generation of metadata within the cell is also not yet implemented.
+		#
+		# @param [Integer] indent defines the indentation of the cell content
+		# @param [Boolean] last if set to true, the trailing ',' is omitted
+		def generate(indent=1,last=false)
+			@indent = indent
+
+			result = ""
+			result << open_group
+			result << add_field("cell_type", @type)
+			result << add_field("execution_count", @count) if (@type == "code")
+			result << open_group("metadata")
+			# not implemented yet
+			result << close_group
+
+			result << open_array("source")
+			@source.each do |l|
+				result << add_string(l)
+
+				(l == @source.last) ? result << "\n" : result << ",\n"
+			end
+			result << close_array(true)
+			result << close_group(last)
+
+			return result
+		end
+
+		private
+
+		# Returns an array of strings for multi-line parameters like metadata or source
+		# @param param can be given as a string with linebreaks or as an array of strings
+		def read_parameter (param)
+			result = []
+			
+			unless (param.nil? == true)
+				if param.is_a?(String)
+					param.each_line do |l|
+						result << l.chomp
+					end
+				elsif param.is_a?(Array)
+					param.each do |l|
+						next unless l.is_a?(String)
+
+						result << l
+					end
+				end
+			end
+
+			return result
+		end
+
+		include JupyterNB::Helpers
+	end
+end
+

data/lib/generator.rb

@@ -0,0 +1,87 @@
+# Copyright (C) 2018 Hermann Detz
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+
+require "cell"
+require "metadata"
+
+module JupyterNB
+	class Generator
+		# Array of cells (markdown, code, ...) that should be generated within the notebook
+		@cells = []
+
+		# Defines the indent for output lines (used by Helpers module)
+		@indent = 0
+
+		# Stores a metadata object
+		@metadata = nil
+
+		# Default constructor
+		# @param lang can be either :ruby or :python3
+		def initialize(lang)
+			@cells = Array.new
+			
+			if ((lang == :ruby) or (lang == :python3))
+				@metadata = Metadata.new(lang)
+			end
+		end
+
+		# Returns a string that contains an IPython Notebook
+		def generate
+			# start with 1 because everything is encapsulated within {} 
+			# at indent 0
+			@indent = 1
+			result = ""
+			result << "{\n"
+
+			if (@cells.nil? == false) and (@cells.size > 0)
+				result << open_array("cells")
+
+				@cells.each do |c|
+						last = false
+						(c == @cells.last) ? last = true : last = false
+
+						result << c.generate(@indent, last)
+				end
+
+				result << close_array
+			end
+
+			result << generate_metadata
+			result << generate_versioninfo
+			result << "}"
+
+			return result
+		end
+
+		# Adds a content cell to the notebook to be generated
+		# @param [String] type defines the type of the cell (markdown, code, ...)
+		# @param metadata can be given as a string with linebreaks or as an array of strings
+		# @param outputs can be given as a string with linebreaks or as an array of strings		def add_cell(type,metadata,outputs,source)
+		# @param source can be given as a string with linebreaks or as an array of strings
+		def add_cell(type,metadata,outputs,source)
+			@cells << Cell.new(type,metadata,outputs,source)
+		end
+
+		private
+
+		include JupyterNB::Helpers
+
+		# Returns a string containing the metadata of the IPython Notebook
+		def generate_metadata
+			return @metadata.generate(@indent)
+		end
+
+		# Returns a string that contains the version information of the
+		# IPython Notebook
+		# The values are reverse engineered from a jupyterhub project.
+		def generate_versioninfo
+			result = ""
+			result << add_field("nbformat", 4)
+			result << add_field("nbformat_minor", 2, true)
+			return result
+		end
+	end
+end
+

data/lib/helpers.rb

@@ -0,0 +1,123 @@
+# Copyright (C) 2018 Hermann Detz
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+
+module JupyterNB
+	module Helpers
+		# Returns a string that contains a single automatically indented string
+		#
+		# This is used to output source code within cells.
+		# @param [String] str contains the string to be indented and contained in ""
+		def add_string(str)
+			line = ""
+			@indent.times do line << " " end
+			line << "\"#{str}\\n\""
+			return line
+		end
+
+		# Returns a string that contains a single field for a notebook
+		#
+		# This is e.g. used to output the cell type:
+		#   "cell_type": "code",
+		#
+		# @param [String] name Name of the field (e.g. cell_type)
+		# @param value can be a String or Integer
+		# @param [Boolean] last if set to true, the trailing ',' is omitted
+		def add_field(name, value, last=false)
+			line = ""
+			@indent.times do line << " " end
+
+			line << "\"#{name}\": "
+			
+			line << "\"#{value}\"" if value.is_a?(String)
+			line << "#{value}" if value.is_a?(Integer)
+			
+			last ? line << "\n" : line << ",\n"
+
+			return line
+		end
+
+		# Returns a string that opens a group within a notebook
+		# The indentation is automatically increased by one.
+		#
+		# This is e.g. used to output the metadata:
+		#   "metadata": {
+		#
+		# @param [String] name Name of the group (e.g. metadata)
+		def open_group(name="")
+			line = ""
+			@indent.times do line << " " end
+
+			if name != ""
+				line << "\"#{name}\": {\n"
+			else
+				line << "{\n"
+			end
+
+			@indent += 1
+
+			return line
+		end
+
+		# Returns a string that closes a group within a notebook
+		# The indentation is automatically decreased by one.
+		#
+		# This is e.g. used to close the metadata:
+		#   },
+		#
+		# @param [Boolean] last if set to true, the trailing ',' is omitted
+		def close_group(last=false)
+			# decrease indent first to bring closing bracked to the
+			# same indent as opening bracket
+			@indent -= 1
+
+			line = ""
+			@indent.times do line << " " end
+
+			line << "}"
+			last ? line << "\n" : line << ",\n"
+
+			return line
+		end
+
+		# Returns a string that opens a group within a notebook
+		# The indentation is automatically increased by one.
+		#
+		# This is e.g. used to output the cells:
+		#   "cells": [
+		#
+		# @param [String] name Name of the array (e.g. cells)
+		def open_array(name)
+			line = ""
+			@indent.times do line << " " end
+
+			line << "\"#{name}\": [\n"
+
+			@indent += 1
+
+			return line
+		end
+
+		# Returns a string that closes a group within a notebook
+		# The indentation is automatically decreased by one.
+		#
+		# This is e.g. used to close the metadata:
+		#   ],
+		#
+		# @param [Boolean] last if set to true, the trailing ',' is omitted
+		def close_array(last=false)
+			# decrease indent first to bring closing bracked to the
+			# same indent as opening bracket
+			@indent -= 1
+
+			line = ""
+			@indent.times do line << " " end
+
+			line << "]"
+			last ? line << "\n" : line << ",\n"
+
+			return line
+		end
+	end
+end

data/lib/jupyternb.rb

@@ -0,0 +1,6 @@
+# Copyright (C) 2018 Hermann Detz
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+
+require "generator"

data/lib/metadata.rb

@@ -0,0 +1,86 @@
+# Copyright (C) 2018 Hermann Detz
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+
+module JupyterNB
+	class Metadata
+		# Defines the indent for output lines (used by Helpers module)
+		@indent = 0
+		@kernel = {}
+		@langinfo = {}
+
+		# Constructor
+		# @param lang can be either :ruby or :python3
+		def initialize(lang)
+			@kernel = {}
+			@langinfo = {}
+
+			case lang
+			when :ruby then initialize_ruby
+			when :python3 then initialize_python3
+			end
+		end
+
+		# Returns a string containing the metadata of the IPython Notebook
+		# @param [Integer] indent defines the indentation of the generated output.
+		def generate(indent=0)
+			@indent = indent
+
+			result = ""
+			result << open_group("metadata")
+			result << open_group("kernelspec")
+			result << add_field("display_name", @kernel[:displayname])
+			result << add_field("language", @kernel[:language])
+			result << add_field("name", @kernel[:name], true)
+			result << close_group
+			result << open_group("language_info")
+			result << add_field("file_extension", @langinfo[:fileext])
+			result << add_field("mimetype", @langinfo[:mime])
+			result << add_field("name", @langinfo[:name])
+			result << add_field("version", @langinfo[:version], true)
+			result << close_group(true)
+			result << close_group
+			return result
+		end
+
+
+		private
+
+		include JupyterNB::Helpers
+
+		# Initialize metadata for Ruby kernel
+		def initialize_ruby
+			@kernel[:language] = "ruby"
+			@kernel[:name] = "ruby"
+			@kernel[:displayname] = "Ruby #{RUBY_VERSION}"
+
+			@langinfo[:name] = "ruby"
+			@langinfo[:fileext] = ".rb"
+			@langinfo[:mime] = "application/x-ruby"
+			@langinfo[:version] = RUBY_VErSION
+		end
+
+		# Initialize metadata for Python 3 kernel
+		def initialize_python3
+			@kernel[:language] = "python"
+			@kernel[:name] = "python3"
+			@kernel[:displayname] = "Python 3"
+
+			@langinfo[:name] = "python"
+			@langinfo[:fileext] = ".py"
+			@langinfo[:mime] = "text/x-python"
+
+			# Check for python3
+			`which python3`
+			if $?.success?
+				@langinfo[:version] = `python3 -V`.split(' ').last
+			else
+				# Fall back to initial 3.0 release, if no python3 executable is found
+				@langinfo[:version] = '3.0'
+			end
+		end
+
+	end
+end
+

data/lib/version.rb

@@ -0,0 +1,10 @@
+# Copyright (C) 2018 Hermann Detz
+#
+# This software may be modified and distributed under the terms
+# of the MIT license.  See the LICENSE file for details.
+
+module JupyterNB
+	VERSION = "0.1.1"
+end
+
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: jupyternb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Hermann Detz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-29 00:00:00.000000000 Z
+dependencies: []
+description: "                       This gem provides useful functions to work with\n\t\t\t\t\t\t\t\t\t\t\t
+  Jupyter Notebook files.\n"
+email:
+- hermann.detz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- jupyternb.gemspec
+- lib/cell.rb
+- lib/generator.rb
+- lib/helpers.rb
+- lib/jupyternb.rb
+- lib/metadata.rb
+- lib/version.rb
+homepage: https://github.com/hermanndetz/jupyternb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Jupyter Notebook Tools
+test_files: []