jupyter_on_rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23abc55bf5cdbb25fcedc441594b67deba55617f1064376785719b254e1dd1fe
+  data.tar.gz: b1f90644a6c73ebb3bb798064012f4db785683542df034c15ea37aabd4d8fdeb
+SHA512:
+  metadata.gz: 82d708ee1ed8ec629a3eb2fa4cec1b7b356ef6849bf4d3c5574e8b5a7e6ef1fca5a7071f0d51e8d3576535c1bfdc5fa7cd310aede308f0e9e88cce4cd46e5d66
+  data.tar.gz: 618abf46f0a4977e5ff9129b22bbfef5924254fd3240030802e323cb51f265e85c4593f9037d61a6eac28a63a5767ef7d6f31a5645de5659aa236108c5bf53d2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jupyter_on_rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,77 @@
+# JupyterOnRails
+
+Rails is loaded on jupyter dead easy.
+
+![Alt text](the_screenshot.png?raw=true "Title")
+
+## Motivation
+
+Although it was already possible to run `jupyter` + `iruby` and `require app_full_path` to load Rails application context,
+it is a bit tiring to each time copy all the `require` statements.
+
+Moreover, since Rails Way works in keeping (generally) everything under the project directory,
+managing the jupyter configuration installed in user global area (the iruby kernel register thing) is again a bit awkward.
+
+With this gem, these awkwardness is to solved by following instruments:
+  * `rake jupyter:notebook` Railtie command which invokes jupyter at your project root, and
+  * The rails kernel dynamically defined by the rake task which automatically loads your Rails application.
+
+
+## Prerequisites
+
+* iruby's prerequisites must be met.
+  * Refer: https://github.com/SciRuby/iruby
+    * Either `cztop` or `ffi-rzmq` gem must be installable.
+
+* `jupyter` command must be somehow available.
+  * Either
+    * `jupyter` command (pip global install, anaconda, etc), or
+    * `pipenv run jupyter` command (managed by Pipfile at project root)
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'jupyter_on_rails'
+
+# For sessions pick either:
+gem 'ffi-rzmq'
+# Or
+gem 'cztop'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Starting the jupyter server is available as a rake command.
+
+Just execute:
+
+```sh
+rake jupyter:notebook
+```
+
+Eventually, you'll have jupyter opened, and the kernel being available.
+
+## Development
+
+This is a railtie gem, so you'd probably want to do something like:
+
+```
+gem 'jupyter_on_rails', git: 'GIT_URL_OF_YOUR_REPO',
+                        branch: 'the-work-branch'
+```
+
+or
+
+```
+gem `jupyter_on_rails`, path: 'jupyter_on_rails_as_sub_project'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Yuki-Inoue/jupyter_on_rails.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jupyter_on_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jupyter_on_rails.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jupyter_on_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jupyter_on_rails"
+  spec.version       = JupyterOnRails::VERSION
+  spec.authors       = ["Yuki INOUE"]
+  spec.email         = ["inoueyuworks@gmail.com"]
+
+  spec.summary       = %q{Integrate jupyter into rails}
+  spec.description   = %q{`rails jupyter:notebook` to open jupyter with rails app kernel of your project.}
+  spec.homepage      = "https://github.com/Yuki-Inoue/jupyter_on_rails"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Yuki-Inoue/jupyter_on_rails"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'railties'
+  spec.add_dependency 'iruby'
+end

data/lib/jupyter_on_rails/boot.rb

@@ -0,0 +1,14 @@
+root = ENV.fetch('RAILS_ROOT')
+
+boot_file = File.expand_path('config/boot.rb', root)
+require boot_file
+
+require_relative 'iruby_kernel_extention'
+JupyterOnRails::IRubyKernelExtention.root = root
+
+require 'iruby'
+module IRuby
+  class Kernel
+    prepend JupyterOnRails::IRubyKernelExtention
+  end
+end

data/lib/jupyter_on_rails/iruby_kernel_extention.rb

@@ -0,0 +1,18 @@
+module JupyterOnRails
+  module IRubyKernelExtention
+    class << self
+      attr_accessor :root
+    end
+
+    def run
+      original = Dir.pwd
+      root = IRubyKernelExtention.root
+      Dir.chdir root
+      app_file = File.expand_path('config/application.rb', root)
+      require app_file
+      Rails.application.require_environment!
+      Dir.chdir original
+      super
+    end
+  end
+end

data/lib/jupyter_on_rails/railtie/jupyter.rake

@@ -0,0 +1,30 @@
+require 'shellwords'
+require 'json'
+
+namespace :jupyter do
+  desc 'start jupyter notebook'
+  task :notebook do
+    root = Rails.root
+    ipython_dir = ENV['IPYTHONDIR'] || root / '.ipython'
+    ipython_dir = File.absolute_path(ipython_dir.to_s)
+
+    sh "bundle exec iruby register --force --ipython-dir=#{Shellwords.shellescape(ipython_dir.to_s)}"
+
+    sh "rm -rf #{Shellwords.shellescape(ipython_dir.to_s)}/kernels/rails"
+    sh "cp -r #{Shellwords.shellescape(ipython_dir.to_s)}/kernels/ruby #{Shellwords.shellescape(ipython_dir.to_s)}/kernels/rails"
+
+    kernel_file = File.expand_path('kernels/rails/kernel.json', ipython_dir.to_s)
+    kernel_h = JSON.parse(File.read(kernel_file))
+    kernel_h['argv'] << File.expand_path('../boot.rb', __dir__)
+    kernel_h['display_name'] = "#{Rails.application.class.parent} (rails #{Rails.version})"
+    kernel_h['env'] ||= {}
+    kernel_h['env']['RAILS_ROOT'] = root.to_s
+
+    File.write(kernel_file, JSON.dump(kernel_h))
+
+    env = { 'IPYTHONDIR' => ipython_dir.to_s }
+    commands = %w[jupyter notebook]
+    commands = %w[pipenv run] + commands if (root / 'Pipfile').exist?
+    Process.exec(env, *commands)
+  end
+end

data/lib/jupyter_on_rails/railtie.rb

@@ -0,0 +1,7 @@
+module JupyterOnRails
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'jupyter_on_rails/railtie/jupyter.rake'
+    end
+  end
+end

data/lib/jupyter_on_rails/version.rb

@@ -0,0 +1,3 @@
+module JupyterOnRails
+  VERSION = '0.2.0'
+end

data/lib/jupyter_on_rails.rb

@@ -0,0 +1,7 @@
+require 'jupyter_on_rails/version'
+
+module JupyterOnRails
+  class Error < StandardError; end
+end
+
+require 'jupyter_on_rails/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: jupyter_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Yuki INOUE
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: iruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "`rails jupyter:notebook` to open jupyter with rails app kernel of your
+  project."
+email:
+- inoueyuworks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jupyter_on_rails.gemspec
+- lib/jupyter_on_rails.rb
+- lib/jupyter_on_rails/boot.rb
+- lib/jupyter_on_rails/iruby_kernel_extention.rb
+- lib/jupyter_on_rails/railtie.rb
+- lib/jupyter_on_rails/railtie/jupyter.rake
+- lib/jupyter_on_rails/version.rb
+- the_screenshot.png
+homepage: https://github.com/Yuki-Inoue/jupyter_on_rails
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Yuki-Inoue/jupyter_on_rails
+  source_code_uri: https://github.com/Yuki-Inoue/jupyter_on_rails
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Integrate jupyter into rails
+test_files: []