WIP rewrite (#40)

* copy paste PlotlyX over here

* wip

* update project.toml

* change generate_traces.jl and add a schema object

* update artifacts

* rework traces

* bye bye Julai 1.6

* wip trace

* add plot, which is way smarter than auto-generated trace functions

* new readme

* readme

* add save, some readme stuff

* readme

* readme and bump version

Author: joshday

.github/workflows/CI.yml

@@ -1,7 +1,6 @@
 name: CI
 on:
   push:
-    branches: [master]
     tags: ["*"]
   pull_request:
 jobs:
@@ -12,7 +11,6 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
           - '1' # automatically expands to the latest stable 1.x release of Julia
           - 'nightly'
         os:

.github/workflows/CompatHelper.yml

@@ -0,0 +1,16 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

Artifacts.toml

@@ -4,3 +4,10 @@ git-tree-sha1 = "454cd11f76e34fb3c8163fdef1e071633f1ece18"
     [[PlotlyLight.download]]
     sha256 = "af56c1871c5ccdb6b51022b378b023dce3df56c18d6b2d21f78c25d1d0b9b486"
     url = "https://gist.github.com/joshday/6454da06baf6d0ca532c08ba04b76855/raw/454cd11f76e34fb3c8163fdef1e071633f1ece18.tar.gz"
+
+[plotly_artifacts]
+git-tree-sha1 = "732abe4f42a5631b96e7b7a003161af12b0a4178"
+
+    [[plotly_artifacts.download]]
+    sha256 = "2682c0da29cf273ef89ba58e04b38c9fc69e664e6e968d6e8e7b4e9bff8f9727"
+    url = "https://gist.github.com/joshday/8312806ce405dbc529e9381d4d92f14c/raw/732abe4f42a5631b96e7b7a003161af12b0a4178.tar.gz"

Project.toml

@@ -1,30 +1,31 @@
 name = "PlotlyLight"
 uuid = "ca7969ec-10b3-423e-8d99-40f33abb42bf"
 authors = ["joshday <[email protected]>"]
-version = "0.7.5"
+version = "0.8.0"
 
 [deps]
 Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
 Cobweb = "ec354790-cf28-43e8-bb59-b484409b7bad"
-DefaultApplication = "3f0dd361-4fe0-5fc6-8523-80b14ec94d85"
 Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 EasyConfig = "acab07b0-f158-46d4-8913-50acef6d41fe"
 JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
+REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-Scratch = "6c6a2e73-6563-6170-7368-637461726353"
 StructTypes = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
 
 [compat]
-Cobweb = "0.5.1"
-DefaultApplication = "1"
-EasyConfig = "0.1.11"
-JSON3 = "1.8"
-Scratch = "1.2"
-StructTypes = "1"
-julia = "^1.6"
+Artifacts = "1.3"
+Aqua = "0.8"
+Cobweb = "0.6"
+Downloads = "1.6"
+EasyConfig = "0.1"
+JSON3 = "1.14"
+StructTypes = "1.10"
+julia = "1.7"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["Test", "Aqua"]

README.md

@@ -7,26 +7,23 @@
 
 <br><br>
 
-# Features
+## ✨ Features
 
 - 🚀 Fastest time-to-first-plot in Julia!
 - 🌐 Use the [Plotly.js Javascript documentation](https://plotly.com/javascript/) directly.  No magic syntax: Just [`JSON3.write`](https://github.com/quinnj/JSON3.jl).
-    - Set deeply-nested keys easily with [`EasyConfig.jl`](https://github.com/joshday/EasyConfig.jl).
-        - e.g. `myplot.layout.xaxis.title.font.family = "Arial"`
-- 🕸️ Plays nicely with [Cobweb.jl](https://github.com/joshday/Cobweb.jl) to display or save plots as HTML.
-- 🎈 Plots will appear in `MIME"text/html"` environments (like [Pluto.jl](https://github.com/fonsp/Pluto.jl)).
+- 📂 Set deeply-nested keys easily, e.g. `myplot.layout.xaxis.title.font.family = "Arial"`.
 - 📊 The Same [built-in themes](https://plotly.com/python/templates/) as Plotly's python package.
 
 <br><br>
 
-# 🚀 Quickstart
+## 🚀 Quickstart
 
 ```julia
 using PlotlyLight
 
-Preset.Template.plotly_dark!()  # Change template
+preset.template.plotly_dark!()  # Change template
 
-p = Plot(x = 1:20, y = cumsum(randn(20)), type="scatter", mode="lines+markers")  # Make plot
+p = plot(x = 1:20, y = cumsum(randn(20)), type="scatter", mode="lines+markers")  # Make plot
 
 p.layout.title.text = "My Title!"  # Make changes
 
@@ -38,133 +35,99 @@ p  # `display(p)` to see the updated plot
     <img width=650 src="https://user-images.githubusercontent.com/8075494/213164013-3ba1a108-122a-4339-a0a2-fa2175fa06e3.png">
 </p>
 
-#### Adding Traces
+## 📈 Traces
 
-- Calling a `Plot` object will add a trace:
+- A core concept in Plotly is that of a *trace*, which is the data along with specifications on how to plot it.
+- There are many different trace *types* (e.g. "scatter" for scatterplots, "box" for boxplots).
 
-```julia
-Plot()(
-    x = 1:10, y = randn(10), name = "trace 1"
-)(
-    x = 3:12, y = randn(10), name = "trace 2"
-)
-```
-
-<br><br>
-
-# 📄 Saving Plots
 
-## Save HTML files with [Cobweb.jl](https://github.com/joshday/Cobweb.jl)
+PlotlyLight does some simple "tricks" with the `plot` function so that:
 
 ```julia
-using Cobweb
-
-page = Cobweb.Page(p)
-
-Cobweb.save(page, "myplot.html")
+plot.trace(; kw...) == plot(; type=trace, kw...)
 ```
 
-## Save images with [PlotlyKaleido.jl](https://github.com/JuliaPlots/PlotlyKaleido.jl)
+**This lets you tab-autocomplete the trace type:**
 
 ```julia
-using PlotlyKaleido
-
-PlotlyKaleido.savefig(p, "myplot.png")
+julia> plot.<TAB>
+# bar                 barpolar            box                 candlestick         carpet              choropleth          choroplethmapbox
+# cone                contour             contourcarpet       densitymapbox       funnel              funnelarea          heatmap
+# heatmapgl           histogram           histogram2d         histogram2dcontour  icicle              image               indicator
+# isosurface          mesh3d              ohlc                parcats             parcoords           pie                 pointcloud
+# sankey              scatter             scatter3d           scattercarpet       scattergeo          scattergl           scattermapbox
+# scatterpolar        scatterpolargl      scattersmith        scatterternary      splom               streamtube          sunburst
+# surface             table               treemap             violin              volume              waterfall
 ```
 
-<br><br>
-
-# `?Plot`
+**You can chain the dot syntax to add traces to a plot, e.g.**
 
 ```julia
-Plot(data, layout=Config(), config=Config())
-Plot(;layout=Config(), config=Config(), kw...)
+y = randn(20)
+
+plot.bar(; y).scatter(; y)
 ```
 
-Create a Plotly plot with the given `data` (`Config` or `Vector{Config}`), `layout`, and `config`.
-Alternatively, you can create a plot with a single trace by providing the `data` as keyword arguments.
+<br><br>
 
-For more info, read the Plotly.js docs: [https://plotly.com/javascript/](https://plotly.com/javascript/).
+## 📄 Saving Plots
 
-### Examples
+### Saving Plots As HTML
 
 ```julia
-p = Plot(Config(x=1:10, y=randn(10)))
+p = plot(y=rand(10))
 
-p = Plot(; x=1:10, y=randn(10))
+PlotlyLight.save(p, "myplot.html")
 ```
 
-<br><br>
+- Note: call `preset.source.standalone!()` first if you want the html file to contain the entire plotly.js script.  This enables you to view the plot even without internet access.
 
-# ⚙️ Presets and Settings
 
-- There are several presets that can make your life easier, located in the `Preset` module.
-- Each preset is a function that you set via `Preset.[Template|Source|PlotContainer].<preset!>`
+### Save Plots as Image via [PlotlyKaleido.jl](https://github.com/JuliaPlots/PlotlyKaleido.jl)
 
+```julia
+using PlotlyKaleido
 
-## `Preset.Template`
+PlotlyKaleido.start()
 
-- The template/theme of the plot.
+(;data, layout, config) = p
 
-```julia
-ggplot2!
-gridon!
-none!
-plotly!
-plotly_dark!
-plotly_white!
-presentation!
-seaborn!
-simple_white!
-xgridoff!
-ygridoff!
+PlotlyKaleido.savefig((; data, layout, config), "myplot.png")
 ```
 
+<br><br>
 
-## `Preset.Source`
+## 🎛️ Presets
 
-- How the Plotly.js library gets loaded when the plot is displayed in a browser.
+### Theme Presets
+
+Set a theme/template via `preset.template.<option>!()`.  Note that options are tab-autocomplete-able.  These are borrowed from the [built-in themes](https://plotly.com/python/templates/) in the plotly python package.
 
 ```julia
-cdn!        # Use https://cdn.plot.ly/plotly-<version>.min.js to load Plotly.js.
-local!      # Use a local copy of Plotly.
-none!       # Do not load Plotly.js
-standalone! # Create a standalone html file that hard-codes Plotly.js into it.
+preset.template.ggplot2!()
 ```
 
-## `Preset.PlotContainer`
+### Source Presets
 
-- The HTML `<div>` that the plot will be inserted into.
+Change how the plotly.js script gets loaded in the produced html via `preset.source.<option>!()`.
 
 ```julia
-auto!           # Automatically choose one of the above based on `stdout`.
-fillwindow!     # Fill the height/width of the page (REPL default).
-iframe!         # Wrap the Plot inside an <iframe> (Jupyter[lab] default).
-pluto!          # Use the full width of a Pluto cell (Pluto default).
-responsive!     # Fill whatever container the plot lives in.
+preset.source.none!()       # Don't include the script.
+preset.source.cdn!()        # Use the official plotly.js CDN.
+preset.source.local!()      # Use a local version of the plotly.js script.
+preset.source.standalone!() # Copy-paste the plotly.js script into the html output.
 ```
 
-## Manual Settings
-
-If the available `Preset`s aren't enough to satisfy your use case, you can override the settings to your own preferences via the `settings!(; kw...)` function.
-
-- `load_plotlyjs`
-    - A function that returns a `MIME("text/html")`-representable object that will load the Plotly.js library.
-    -  Default value:
-    ```julia
-    () -> Cobweb.h.script(src=PlotlyLight.cdn_url[], charset="utf-8")
-    ```
-- `make_container = (id::String) -> Cobweb.h.div(; id=id)`
-    - A function of an identifier that returns a `MIME("text/html")`-representable object that will write the `<div>` to be populated with the plot.
-- `layout = Config()` and `config = Config()`
-    - The default `layout` and `config`.  They will be merged with the `Plot`'s `layout`/`config` (conflicting values will taken from the `Plot`).
-- `iframe::Union{Nothing, Cobweb.IFrame} = nothing`
-    - A `Cobweb.IFrame` to use as a template to wrap the plot in, e.g. `Cobweb.IFrame(""; height="500px", width="600px")`.
+## ⚙️ Settings
 
-# Update/Change the Version of Plotly.js
+Occasionally `preset`s aren't enough.  Lower level user-configurable settings are available in `PlotlyLight.settings`:
 
 ```julia
-PlotlyLight.update!() # update to latest released version
-
-PlotlyLight.update!(v"2.24.2")  # update to specific release.
+PlotlyLight.settings.src::Cobweb.Node           # plotly.js script loader
+PlotlyLight.settings.div::Cobweb.Node           # The plot-div
+PlotlyLight.settings.layout::EasyConfig.Config  # default `layout` for all plots
+PlotlyLight.settings.config::EasyConfig.Config  # default `config` for all plots
+PlotlyLight.settings.reuse_preview::Bool        # In the REPL, open plots in same page (true, the default) or different pages.
 ```
+
+Check out e.g. `PlotlyLight.Settings().src` to examine default values.

deps/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+ArtifactUtils = "8b73e784-e7d8-4ea5-973d-377fed4e3bce"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"

deps/artifacts.jl

@@ -0,0 +1,34 @@
+using Pkg
+Pkg.activate(@__DIR__)
+
+using ArtifactUtils, JSON3
+
+version = JSON3.read(download("https://api.github.com/repos/plotly/plotly.js/releases/latest")).name
+
+
+#-----------------------------------------------------------------------------# get urls
+plotly_url = "https://github.com/plotly/plotly.js/raw/$version/dist/plotly.min.js"
+
+schema_url = "https://github.com/plotly/plotly.js/raw/$version/dist/plot-schema.json"
+
+template_urls = Dict(
+    t => "https://raw.githubusercontent.com/plotly/plotly.py/master/packages/python/plotly/plotly/package_data/templates/$t.json" for t in
+        (:ggplot2, :gridon, :plotly, :plotly_dark, :plotly_white, :presentation, :seaborn, :simple_white, :xgridoff, :ygridoff)
+)
+
+#-----------------------------------------------------------------------------# make tempdir
+dir = mktempdir()
+mkdir(joinpath(dir, "templates"))
+
+#-----------------------------------------------------------------------------# download
+open(io -> println(io, version), joinpath(dir, "version.txt"), "w")
+download(plotly_url, joinpath(dir, "plotly.min.js"))
+download(schema_url, joinpath(dir, "plot-schema.json"))
+for (k,v) in template_urls
+    download(v, joinpath(dir, "templates", "$k.json"))
+end
+
+#-----------------------------------------------------------------------------# make artifact
+artifact_id = artifact_from_directory(dir)
+gist = upload_to_gist(artifact_id)
+add_artifact!("Artifacts.toml", "plotly_artifacts", gist; force=true)