nanoc-nbconvert 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWFiZGEzMzExODJhYjUyY2I2MjhhYzhiYjY5MGNiMmI4NGQ1ZWUyZQ==
+  data.tar.gz: !binary |-
+    NmZmYTZiOGM5MzRhMzUzYjVhYjY5ZTg1Mjk0MWFkZTFjYjQ1NDU4Yg==
+SHA512:
+  metadata.gz: !binary |-
+    YTY5ZTFmYjAyZThhNDI4NmNjNTc0MGIzOThmZjkyOTkwYjYzM2IyYjMxYzM3
+    ODBmYjJkNDhmMzM0NjY5MjJkODBkNWExZWI1MTdmMGRmYzBlYjYzMzUwMDkw
+    ZDg4MmFmZWQzMTQ1NjI4NzZiNGUwNjQ5YzQ3MzFmZjU3ZjA0ZjI=
+  data.tar.gz: !binary |-
+    YmUxY2MwOGUzNmVhMWEyMDYxNTMwNGMxNjY1ZDY2MTUwMTExMGYwMmQ5Y2Zh
+    MzU5MTNiN2MyYWVlMDE4YTFkYjIxNDUwYjgwZjc1ODAzYzA5ZDJhNzAxMmNm
+    NGY5ZDBmNjUxMjI4ZWY0Mjc3NDQ5MTk1ZGIxZWIzZWMxNDk0ZjY=

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    nanoc-nbconvert (0.0.1.0)
+      nanoc
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    cri (2.5.0)
+      colored (~> 1.2)
+    minitest (5.3.0)
+    nanoc (3.6.7)
+      cri (~> 2.3)
+    rake (10.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  nanoc-nbconvert!
+  rake

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Kun Xi and contributors
+
+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/NEWS.md

@@ -0,0 +1,5 @@
+# nanoc-nbconvert news
+
+## 1.0.0
+
+Initial release.

data/README.md

@@ -0,0 +1,15 @@
+[![Build Status](https://travis-ci.org/kunxi/nanoc-nbconvert.png)](https://travis-ci.org/kunxi/nanoc-nbconvert)
+
+# nanoc-nbconvert
+
+This provides a [IPython notebook](http://ipython.org/notebook) filter for [nanoc](http://nanoc.ws) using [nbconvert](http://ipython.org/ipython-doc/rel-1.0.0/interactive/nbconvert.html).
+
+## Installation
+
+`gem install nanoc-nbconvert`
+
+## Usage
+
+```ruby
+filter :nbconvert
+```

data/Rakefile

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = %w( lib test )
+  t.test_files = FileList['test/**/test_*.rb', 'test/**/*_spec.rb']
+end
+
+task :default => :test

data/lib/nanoc/filters/nbconvert.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require "open3"
+
+module Nanoc::Filters
+
+  class NBConvert < Nanoc::Filter
+
+    identifier :nbconvert
+
+    def run(content, params={})
+      nbconvert = <<'END'
+import sys
+
+from IPython.nbconvert import HTMLExporter
+exportor = HTMLExporter(template_file="basic")
+body, _ = exportor.from_file(sys.stdin)
+sys.stdout.write(body)
+END
+      python_bin = params[:python_bin] || 'python'
+      o, e, s = Open3.capture3("#{python_bin} -c '#{nbconvert}'",
+                               :stdin_data=>content.to_s)
+      if !s.success?
+        raise "nbconvert fails: #{e}"
+      end
+      o
+    end
+
+  end
+
+end

data/nanoc-nbconvert.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = 'nanoc-nbconvert'
+  s.version     =  '0.1.0'
+  s.homepage    = 'http://github.com/kunxi/nanoc-nbconvert'
+  s.summary     = %q{A nanoc filter to convert IPython notebook}
+  s.description = %q{A nanoc filter to convert IPython notebook}
+
+  s.author  = 'Kun Xi'
+  s.email   = 'kunxi@kunxi.org'
+  s.license = 'MIT'
+
+  s.files              = Dir['[A-Z]*'] +
+                         Dir['{lib,test}/**/*'] +
+                         [ 'nanoc-nbconvert.gemspec' ]
+  s.test_files         = Dir['{test,spec,features}/**/*']
+  s.require_paths      = [ 'lib' ]
+
+  s.rdoc_options     = [ '--main', 'README.md' ]
+  s.extra_rdoc_files = [ 'LICENSE', 'README.md', 'NEWS.md' ]
+
+  s.add_runtime_dependency('nanoc')
+  s.add_development_dependency('bundler')
+end

data/test/data/example.html

@@ -0,0 +1,134 @@
+
+<div class="cell border-box-sizing text_cell rendered">
+<div class="prompt input_prompt">
+</div>
+<div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<h1 id="an-h1-header">An h1 header</h1>
+<p>Paragraphs are separated by a blank line.</p>
+<p>2nd paragraph. <em>Italic</em>, <strong>bold</strong>, <code>monospace</code>. Itemized lists
+look like:</p>
+<ul>
+<li>this one</li>
+<li>that one</li>
+<li>the other one</li>
+</ul>
+<p>Note that --- not considering the asterisk --- the actual text
+content starts at 4-columns in.</p>
+<blockquote>
+<p>Block quotes are
+written like so.</p>
+<p>They can span multiple paragraphs,
+if you like.</p>
+</blockquote>
+<p>Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex. &quot;it&#39;s all in
+chapters 12--14&quot;). Three dots ... will be converted to an ellipsis.</p>
+<h2 id="an-h2-header">An h2 header</h2>
+<p>Here&#39;s a numbered list:</p>
+<ol>
+<li>first item</li>
+<li>second item</li>
+<li>third item</li>
+</ol>
+<p>Note again how the actual text starts at 4 columns in (4 characters
+from the left side). Here&#39;s a code sample:</p>
+<pre><code># Let me re-iterate ...
+for i in 1 .. 10 { do-something(i) }
+</code></pre><p>As you probably guessed, indented 4 spaces. By the way, instead of
+indenting the block, you can use delimited blocks, if you like:</p>
+<pre><code>define foobar() {
+    print &quot;Welcome to flavor country!&quot;;
+}
+</code></pre><p>(which makes copying &amp; pasting easier). You can optionally mark the
+delimited block for Pandoc to syntax highlight it:</p>
+<pre><code class="language-python"><span class="keyword">import</span> time
+<span class="comment"># Quick, count to ten!</span>
+<span class="keyword">for</span> i <span class="keyword">in</span> range(<span class="number">10</span>):
+    <span class="comment"># (but not *too* quick)</span>
+    time.sleep(<span class="number">0.5</span>)
+    <span class="keyword">print</span> i
+</code></pre>
+<h3 id="an-h3-header">An h3 header</h3>
+<p>Now a nested list:</p>
+<ol>
+<li><p>First, get these ingredients:</p>
+<ul>
+<li>carrots</li>
+<li>celery</li>
+<li>lentils</li>
+</ul>
+</li>
+<li><p>Boil some water.</p>
+</li>
+<li><p>Dump everything in the pot and follow
+this algorithm:</p>
+<pre><code>find wooden spoon
+uncover pot
+stir
+cover pot
+balance wooden spoon precariously on pot handle
+wait 10 minutes
+goto first step (or shut off burner when done)
+</code></pre><p>Do not bump wooden spoon or it will fall.</p>
+</li>
+</ol>
+<p>Notice again how text always lines up on 4-space indents (including
+that last line which continues item 3 above). Here&#39;s a link to <a href="http://foo.bar">a
+website</a>. Here&#39;s a link to a <a href="local-doc.html">local
+doc</a>. Here&#39;s a footnote [^1].</p>
+<p>[^1]: Footnote text goes here.</p>
+<p>Tables can look like this:</p>
+<p>size  material      color</p>
+<hr>
+<p>9     leather       brown
+10    hemp canvas   natural
+11    glass         transparent</p>
+<p>Table: Shoes, their sizes, and what they&#39;re made of</p>
+<p>(The above is the caption for the table.) Here&#39;s a definition list:</p>
+<p>apples
+  : Good for making applesauce.
+oranges
+  : Citrus!
+tomatoes
+  : There&#39;s no &quot;e&quot; in tomatoe.</p>
+<p>Again, text is indented 4 spaces. (Alternately, put blank lines in
+between each of the above definition list lines to spread things
+out more.)</p>
+<p>Inline math equations go in like so: $\omega = d\phi / dt$. Display
+math should get its own line and be put in in double-dollarsigns:</p>
+<p>$$I = \int \rho R^{2} dV$$</p>
+<p>Done.</p>
+</div>
+</div>
+</div>
+<div class="cell border-box-sizing code_cell rendered">
+<div class="input">
+<div class="prompt input_prompt">
+In&nbsp;[1]:
+</div>
+<div class="inner_cell">
+    <div class="input_area">
+<div class="highlight"><pre><span class="k">print</span> <span class="s">&quot;Hello world&quot;</span>
+</pre></div>
+
+</div>
+</div>
+</div>
+
+<div class="output_wrapper">
+<div class="output">
+
+
+<div class="output_area"><div class="prompt"></div>
+<div class="output_subarea output_stream output_stdout output_text">
+<pre>
+Hello world
+
+</pre>
+</div>
+</div>
+
+</div>
+</div>
+
+</div>

data/test/data/example.ipynb

@@ -0,0 +1,165 @@
+{
+ "metadata": {
+  "name": "",
+  "signature": "sha256:013ede031909463ecfa3223c2666fff0ef08ef47e5cb6f875f8004a36bfe1b47"
+ },
+ "nbformat": 3,
+ "nbformat_minor": 0,
+ "worksheets": [
+  {
+   "cells": [
+    {
+     "cell_type": "markdown",
+     "metadata": {},
+     "source": [
+      "An h1 header\n",
+      "============\n",
+      "\n",
+      "Paragraphs are separated by a blank line.\n",
+      "\n",
+      "2nd paragraph. *Italic*, **bold**, `monospace`. Itemized lists\n",
+      "look like:\n",
+      "\n",
+      "  * this one\n",
+      "  * that one\n",
+      "  * the other one\n",
+      "\n",
+      "Note that --- not considering the asterisk --- the actual text\n",
+      "content starts at 4-columns in.\n",
+      "\n",
+      "> Block quotes are\n",
+      "> written like so.\n",
+      ">\n",
+      "> They can span multiple paragraphs,\n",
+      "> if you like.\n",
+      "\n",
+      "Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex. \"it's all in\n",
+      "chapters 12--14\"). Three dots ... will be converted to an ellipsis.\n",
+      "\n",
+      "\n",
+      "\n",
+      "An h2 header\n",
+      "------------\n",
+      "\n",
+      "Here's a numbered list:\n",
+      "\n",
+      " 1. first item\n",
+      " 2. second item\n",
+      " 3. third item\n",
+      "\n",
+      "Note again how the actual text starts at 4 columns in (4 characters\n",
+      "from the left side). Here's a code sample:\n",
+      "\n",
+      "    # Let me re-iterate ...\n",
+      "    for i in 1 .. 10 { do-something(i) }\n",
+      "\n",
+      "As you probably guessed, indented 4 spaces. By the way, instead of\n",
+      "indenting the block, you can use delimited blocks, if you like:\n",
+      "\n",
+      "~~~\n",
+      "define foobar() {\n",
+      "    print \"Welcome to flavor country!\";\n",
+      "}\n",
+      "~~~\n",
+      "\n",
+      "(which makes copying & pasting easier). You can optionally mark the\n",
+      "delimited block for Pandoc to syntax highlight it:\n",
+      "\n",
+      "~~~python\n",
+      "import time\n",
+      "# Quick, count to ten!\n",
+      "for i in range(10):\n",
+      "    # (but not *too* quick)\n",
+      "    time.sleep(0.5)\n",
+      "    print i\n",
+      "~~~\n",
+      "\n",
+      "\n",
+      "\n",
+      "### An h3 header ###\n",
+      "\n",
+      "Now a nested list:\n",
+      "\n",
+      " 1. First, get these ingredients:\n",
+      "\n",
+      "      * carrots\n",
+      "      * celery\n",
+      "      * lentils\n",
+      "\n",
+      " 2. Boil some water.\n",
+      "\n",
+      " 3. Dump everything in the pot and follow\n",
+      "    this algorithm:\n",
+      "\n",
+      "        find wooden spoon\n",
+      "        uncover pot\n",
+      "        stir\n",
+      "        cover pot\n",
+      "        balance wooden spoon precariously on pot handle\n",
+      "        wait 10 minutes\n",
+      "        goto first step (or shut off burner when done)\n",
+      "\n",
+      "    Do not bump wooden spoon or it will fall.\n",
+      "\n",
+      "Notice again how text always lines up on 4-space indents (including\n",
+      "that last line which continues item 3 above). Here's a link to [a\n",
+      "website](http://foo.bar). Here's a link to a [local\n",
+      "doc](local-doc.html). Here's a footnote [^1].\n",
+      "\n",
+      "[^1]: Footnote text goes here.\n",
+      "\n",
+      "Tables can look like this:\n",
+      "\n",
+      "size  material      color\n",
+      "----  ------------  ------------\n",
+      "9     leather       brown\n",
+      "10    hemp canvas   natural\n",
+      "11    glass         transparent\n",
+      "\n",
+      "Table: Shoes, their sizes, and what they're made of\n",
+      "\n",
+      "(The above is the caption for the table.) Here's a definition list:\n",
+      "\n",
+      "apples\n",
+      "  : Good for making applesauce.\n",
+      "oranges\n",
+      "  : Citrus!\n",
+      "tomatoes\n",
+      "  : There's no \"e\" in tomatoe.\n",
+      "\n",
+      "Again, text is indented 4 spaces. (Alternately, put blank lines in\n",
+      "between each of the above definition list lines to spread things\n",
+      "out more.)\n",
+      "\n",
+      "Inline math equations go in like so: $\\omega = d\\phi / dt$. Display\n",
+      "math should get its own line and be put in in double-dollarsigns:\n",
+      "\n",
+      "$$I = \\int \\rho R^{2} dV$$\n",
+      "\n",
+      "Done."
+     ]
+    },
+    {
+     "cell_type": "code",
+     "collapsed": false,
+     "input": [
+      "print \"Hello world\""
+     ],
+     "language": "python",
+     "metadata": {},
+     "outputs": [
+      {
+       "output_type": "stream",
+       "stream": "stdout",
+       "text": [
+        "Hello world\n"
+       ]
+      }
+     ],
+     "prompt_number": 1
+    }
+   ],
+   "metadata": {}
+  }
+ ]
+}

data/test/filters/test_nbconvert.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'helper'
+
+class Nanoc::Filters::NBConvertTest < Minitest::Test
+
+  def test_filter
+    # Create filter
+    filter = ::Nanoc::Filters::NBConvert.new
+
+    # Run filter
+    fh = File.open(File.expand_path("../../data/example.html", __FILE__))
+    expected = fh.read
+
+    File.open(File.expand_path("../../data/example.ipynb", __FILE__)) {|f|
+      content = f.read
+      assert_match(expected.strip, filter.run(content).strip)
+    }
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'minitest'
+require 'minitest/autorun'
+require 'nanoc'
+require 'nanoc/filters/nbconvert'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-nbconvert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kun Xi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A nanoc filter to convert IPython notebook
+email: kunxi@kunxi.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- NEWS.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- NEWS.md
+- Rakefile
+- README.md
+- lib/nanoc/filters/nbconvert.rb
+- test/data/example.html
+- test/data/example.ipynb
+- test/filters/test_nbconvert.rb
+- test/helper.rb
+- nanoc-nbconvert.gemspec
+homepage: http://github.com/kunxi/nanoc-nbconvert
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A nanoc filter to convert IPython notebook
+test_files:
+- test/data/example.html
+- test/data/example.ipynb
+- test/filters/test_nbconvert.rb
+- test/helper.rb