A tutorial generation script based on Fire. (#3)

Author: GiggleLiu

Diff for: README.md

@@ -30,6 +30,13 @@ PhysicsTutorials.open_notebooks()
 Supported source files for tutorials are Jupyter notebooks, Weave.jl files, or Literate.jl files.
 To contribute a tutorial, clone the repository and put the source file into `tutorials/<category>/<tutorial_name>/` and name it `<tutorial_name>.ipynb` (extension `.jmd`/`.jl` for Weave/Literate sources). To trigger the generation process of all output formats, run the following code from within the repository root folder:
 
+0. Make sure you have `Fire` installed, if not, install it with `julia> ] add Fire`,
+1. Create source file `tutorials/<category>/<tutorial_name>/<tutorial_name>.<extension>`, where the extension should be one of `.ipynb`, `.jl` and `.jmd` .
+2. Type `julia convert.jl tutorials/<category>/<tutorial_name>/<tutorial_name>.<extension>` in a terminal.
+
+
+#### Alternative approach: trigger conversion manually
+
 ```julia
 using Pkg; Pkg.activate(".")
 using PhysicsTutorials

Diff for: convert.jl

@@ -0,0 +1,58 @@
+using Pkg
+#Pkg.activate(dirname(@__FILE__))
+Pkg.activate(@__DIR__)
+using Fire
+using PhysicsTutorials
+
+@main function generate(filename::String)
+    pns = _splitpath(abspath(filename))
+    length(pns) < 3 && error("Invalid path to source file: $filename")
+
+    category, tutorial_name = pns[end-2:end-1]
+    fname, ext = splitext(pns[end])
+
+    fname==tutorial_name || error("tutorial name $tutorial_name is not consistent with filename $fname, expected format: `tutorials/quantum_computing/<name>/<name>.ipynb`")
+
+    if ext == ".ipynb"
+        source = PhysicsTutorials.NotebookSource()
+    elseif ext ==".jmd"
+        source = PhysicsTutorials.WeaveSource()
+    elseif ext ==".jl"
+        source = PhysicsTutorials.LiterateSource()
+    else
+        error("Expected file extension: `*.jl`, `*.jmd` or `*.ipynb`, but got $ext.")
+    end
+    PhysicsTutorials.convert_tutorial(category,tutorial_name,source)
+end
+
+
+# compatibility patch
+const path_dir_splitter = r"^(.*?)([/\\]+)([^/\\]*)$"
+
+_splitdir_nodrive(path::String) = _splitdir_nodrive("", path)
+function _splitdir_nodrive(a::String, b::String)
+    m = match(path_dir_splitter,b)
+    m === nothing && return (a,b)
+    a = string(a, isempty(m.captures[1]) ? m.captures[2][1] : m.captures[1])
+    a, String(m.captures[3])
+end
+
+function _splitpath(p::String)
+    drive, p = splitdrive(p)
+    out = String[]
+    isempty(p) && (pushfirst!(out,p))  # "" means the current directory.
+    while !isempty(p)
+        dir, base = _splitdir_nodrive(p)
+        dir == p && (pushfirst!(out, dir); break)  # Reached root node.
+        if !isempty(base)  # Skip trailing '/' in basename
+            pushfirst!(out, base)
+        end
+        p = dir
+    end
+    if !isempty(drive)  # Tack the drive back on to the first element.
+        out[1] = drive*out[1]  # Note that length(out) is always >= 1.
+    end
+    return out
+end
+
+