Generate badges with versions from Pkg.status

Author: abelsiqueira

Project.toml

@@ -4,6 +4,7 @@ authors = ["Abel Soares Siqueira <[email protected]>"]
 version = "0.2.0"
 
 [deps]
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
@@ -13,6 +14,6 @@ YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 
 [compat]
 IJulia = "1"
-YAML = "0.4"
 Weave = "0.10"
+YAML = "0.4"
 julia = "1.6"

src/JSOTutorials.jl

@@ -2,6 +2,8 @@ module JSOTutorials
 
 # We copied SciML/SciMLTutorials.jl here
 
+include("pkg_list.jl")
+
 using Weave, Pkg, IJulia, InteractiveUtils, Markdown, YAML
 
 repo_directory = joinpath(@__DIR__, "..")
@@ -52,6 +54,7 @@ function weave_file(folder, file, build_list = default_builds)
     dir = joinpath(repo_directory, "markdown", basename(folder))
     mkpath(dir)
     weave(target, doctype = "github", out_path = dir, args = args)
+    add_package_info(joinpath(dir, file[1:end-4] * ".md"))
   end
   if :notebook ∈ build_list
     println("Building Notebook")
@@ -83,6 +86,51 @@ function weave_folder(folder, build_list = default_builds)
   end
 end
 
+function package_information()
+  proj = sprint(io -> Pkg.status(io = io))
+  re_str = r"\[[0-f]+\]\s+(.*) v(.*)"
+  pkg_info = Dict{String,String}()
+  for line in split(proj, "\n")
+    m = match(re_str, line)
+    if m !== nothing
+      pkg_info[m[1]] = m[2]
+    end
+  end
+  return pkg_info
+end
+
+function badge(name, version)
+  color, lbl_color = if name in jso_pkgs
+    color_of_pkg(name)
+  else
+    "000", "fff"
+  end
+
+  badge_img = "<img class=\"badge\" src=\"https://img.shields.io/badge/$name-$version-$color?style=flat-square&labelColor=$lbl_color\">"
+  if name in jso_pkgs
+    link = "https://juliasmoothoptimizers.github.io/$name.jl/stable/"
+    "<a href=\"$link\">$badge_img</a>"
+  else
+    badge_img
+  end
+end
+
+function add_package_info(filename)
+  lines = readlines(filename)
+  j = findall(lines .== "---")[2]
+  pkg_info = package_information()
+  out = [
+    lines[1:j];
+    "";
+    [badge(pkg, ver) for (pkg, ver) in pkg_info];
+    "";
+    lines[j+1:end]
+  ]
+  open(filename, "w") do io
+    print(io, join(out, "\n"))
+  end
+end
+
 function tutorial_footer(folder = nothing, file = nothing)
   display(
     md"""

src/pkg_list.jl

@@ -0,0 +1,23 @@
+using Colors
+
+const model_pkgs = ["ADNLPModels", "AmplNLReader", "BundleAdjustmentModels", "CUTEst", "LLSModels", "ManualNLPModels", "NLPModels", "NLPModelsJuMP", "NLPModelsModifiers", "NLPModelsTest", "NLSProblems", "OptimizationProblems", "PDENLPModels", "QuadraticModels", "QPSReader"]
+const solver_pkgs = ["BenchmarkProfiles", "CaNNOLeS", "DCISolver", "JSOSolvers", "NLPModelsIpopt", "NLPModelsKnitro", "Percival", "RipQP", "SolverCore", "SolverTest", "SolverTools", "SolverBenchmark"]
+const la_pkgs = ["AMD", "BasicLU", "HSL", "Krylov", "LDLFactorizations", "LimitedLDLFactorizations", "LinearOperators", "PROPACK", "MUMPS", "QRMumps", "SparseMatricesCOO", "SuiteSparseMatrixCollection"]
+const jso_pkgs = model_pkgs ∪ solver_pkgs ∪ la_pkgs
+
+const colors = [
+  ("8b0000", "cb3c33"), # Red for models
+  ("006400", "389826"), # Green for solvers
+  ("4b0082", "9558b2"), # Purple for linear algebra
+  ("fff", "000"),
+]
+
+color_of_pkg(pkg) = if pkg in model_pkgs
+  colors[1]
+elseif pkg in solver_pkgs
+  colors[2]
+elseif pkg in la_pkgs
+  colors[3]
+else
+  colors[4]
+end

tutorials/introduction-to-linear-operators/index.jmd

@@ -4,7 +4,8 @@ tags: ["linear-algebra", "linear-operators"]
 author: "Geoffroy Leconte and Dominique Orban"
 ---
 
-[LinearOperators.jl](https://juliasmoothoptimizers.github.io/LinearOperators.jl/stable) is a package for matrix-like operators. Linear operators are defined by how they act on a vector, which is useful in a variety of situations where you don't want to materialize the matrix.
+[LinearOperators.jl](https://juliasmoothoptimizers.github.io/LinearOperators.jl/stable) is a package for matrix-like operators.
+Linear operators are defined by how they act on a vector, which is useful in a variety of situations where you don't want to materialize the matrix.
 
 \toc
 
@@ -264,5 +265,3 @@ opA[:,1] * ones(1)
 ```julia
 opA[1,1] * ones(1)
 ```
-
-