Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 2.0.0 #550

Merged
merged 3 commits into from
Nov 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ git switch -c release_$VF_VERSION
Then update all the package version strings to `X.Y.Z` using the `automation/bump_version.py` script

```bash
python automation/bump_version.py $VF_VERSION
pixi run bump-version $VF_VERSION
```

Open a pull request to merge this branch into `main`. This will start the continuous integration jobs on GitHub Actions. These jobs will test VegaFusion and build packages for publication.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/features/chart_state.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is the foundation of Vega-Altair's [JupyterChart](https://altair-viz.github
.. automethod:: vegafusion.runtime.VegaFusionRuntime.new_chart_state
```

**Example**: See [chart_state.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/chart_state.py) for a complete example.
**Example**: See [chart_state.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/chart_state.py) for a complete example.

## Rust
See [chart_state.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/chart_state.rs) for a complete example.
See [chart_state.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/chart_state.rs) for a complete example.
6 changes: 3 additions & 3 deletions docs/source/features/column_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ When VegaFusion cannot precisely determine which columns are referenced from eac
.. autofunction:: vegafusion.get_column_usage
```

See [column_usage.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/column_usage.py) for a complete example.
See [column_usage.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/column_usage.py) for a complete example.

## Rust
See [column_usage.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/column_usage.rs) for a complete example.
See [column_usage.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/column_usage.rs) for a complete example.

## JavaScript
See the [Editor Demo](https://github.com/vega/vegafusion/tree/v2/examples/editor-demo/src/index.js) for example usage of the `getColumnUsage` function in the `vegafusion-wasm` package.
See the [Editor Demo](https://github.com/vega/vegafusion/tree/main/examples/editor-demo/src/index.js) for example usage of the `getColumnUsage` function in the `vegafusion-wasm` package.
2 changes: 1 addition & 1 deletion docs/source/features/embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ The [`vegafusion-wasm`](https://www.npmjs.com/package/vegafusion-wasm) NPM packa
See the [vegafusion-wasm README](https://github.com/vega/vegafusion/blob/v2/vegafusion-wasm/README.md) for usage instructions.

## Demo
See [editor demo](https://github.com/vega/vegafusion/tree/v2/examples/editor-demo) for a complete example.
See [editor demo](https://github.com/vega/vegafusion/tree/main/examples/editor-demo) for a complete example.
6 changes: 3 additions & 3 deletions docs/source/features/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ vf.runtime.grpc_connect("http://127.0.0.1:50051")

This will cause all VegaFusion runtime operations to be dispatched to the VegaFusion Server.

See [grpc.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/grpc.py) for a complete example.
See [grpc.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/grpc.py) for a complete example.

## Rust
The `GrpcVegaFusionRuntime` struct is an alternative to the `VegaFusionRuntime` struct that provides the same interface, but connects to a VegaFusion Server.

See [grpc.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/grpc.rs) for a complete example.
See [grpc.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/grpc.rs) for a complete example.

## JavaScript
The `vegafusion-wasm` package can connect to an instance of VegaFusion Server over [gRPC-Web](https://github.com/grpc/grpc-web).

See the [editor-demo](https://github.com/vega/vegafusion/tree/v2/examples/editor-demo/README.md) example for more information.
See the [editor-demo](https://github.com/vega/vegafusion/tree/main/examples/editor-demo/README.md) example for more information.
4 changes: 2 additions & 2 deletions docs/source/features/inline_datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ In Python, `inline_datasets` should be a `dict` from dataset names (e.g. `movies

In the case of types supported by Narwhals, VegaFusion will use [`get_column_usage`](./column_usage.md) to project down to the minimal collection of columns that are required, then rely on Narwhals' support for the Arrow PyCapsule API to convert these required columns to an `arro3` Arrow table for zero-copy transfer to Rust.

See [inline_datasets.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/inline_datasets.py) for a complete example with pandas.
See [inline_datasets.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/inline_datasets.py) for a complete example with pandas.

## Rust
In Rust, `inline_datasets` should be a `HashMap<String, VegaFusionDataset>` from dataset names (e.g. `movies` in the example above) to `VegaFusionDataset` instances. `VegaFusionDataset` is an enum that may be either a `VegaFusionTable` (which is a thin wrapper around Arrow RecordBatches), or a DataFusion [`LocalPlan`](https://docs.rs/datafusion/latest/datafusion/logical_expr/enum.LogicalPlan.html) (which represents an arbitrary DataFusion query).

See [inline_datasets.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/inline_datasets.rs) for a complete example using a `VegaFusionTable`, and see [inline_datasets_plan.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/inline_datasets_plan.rs) for a complete example using a DataFusion ``LogicalPlan``.
See [inline_datasets.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/inline_datasets.rs) for a complete example using a `VegaFusionTable`, and see [inline_datasets_plan.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/inline_datasets_plan.rs) for a complete example using a DataFusion ``LogicalPlan``.
4 changes: 2 additions & 2 deletions docs/source/features/transform_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ VegaFusion can be used to evaluate datasets in a Vega spec and return them as ar
.. automethod:: vegafusion.runtime.VegaFusionRuntime.pre_transform_datasets
```

**Example**: See [pre_transform_data.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/pre_transform_data.py) for a complete example.
**Example**: See [pre_transform_data.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/pre_transform_data.py) for a complete example.

## Rust
The Rust API provides a slightly more general `pre_transform_values` method that can extract dataset or signal values.

See [pre_transform_data.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/pre_transform_data.rs) for a complete example of extracting dataset values as arrow tables.
See [pre_transform_data.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/pre_transform_data.rs) for a complete example of extracting dataset values as arrow tables.
4 changes: 2 additions & 2 deletions docs/source/features/transform_extract.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The `pre_transform_extract` method generates a transformed spec like the [`pre_t
.. automethod:: vegafusion.runtime.VegaFusionRuntime.pre_transform_extract
```

**Example**: See [pre_transform_extract.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/pre_transform_extract.py) for a complete example.
**Example**: See [pre_transform_extract.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/pre_transform_extract.py) for a complete example.

## Rust

See [pre_transform_extract.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/pre_transform_extract.rs) for a complete example.
See [pre_transform_extract.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/pre_transform_extract.rs) for a complete example.
4 changes: 2 additions & 2 deletions docs/source/features/transform_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The pre-transform process will, by default, preserve the interactive behavior of
.. automethod:: vegafusion.runtime.VegaFusionRuntime.pre_transform_spec
```

**Example**: See [pre_transform_spec.py](https://github.com/vega/vegafusion/tree/v2/examples/python-examples/pre_transform_spec.py) for a complete example.
**Example**: See [pre_transform_spec.py](https://github.com/vega/vegafusion/tree/main/examples/python-examples/pre_transform_spec.py) for a complete example.

## Rust

See [pre_transform_spec.rs](https://github.com/vega/vegafusion/tree/v2/examples/rust-examples/examples/pre_transform_spec.rs) for a complete example.
See [pre_transform_spec.rs](https://github.com/vega/vegafusion/tree/main/examples/rust-examples/examples/pre_transform_spec.rs) for a complete example.
17 changes: 4 additions & 13 deletions docs/sync_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,11 @@ git pull
# switch to gh-pages branch
git checkout gh-pages

remove all tracked files
git ls-files -z | xargs -0 rm -f

# When the v2 docs become the default, overwrite everything in the branch
# -----------------------------------------------------------------------------
# remove all tracked files
# git ls-files -z | xargs -0 rm -f
#
# # sync files from html build
# rsync -r ../html/ ./
# -----------------------------------------------------------------------------

# While the v1 docs are still the default, only sync the new docs under the v2/ folder
# -----------------------------------------------------------------------------
rsync -r ../html/ ./v2/
# -----------------------------------------------------------------------------
# sync files from html build
rsync -r ../html/ ./

# add commit, and push to github
git add . --all
Expand Down
2 changes: 1 addition & 1 deletion vegafusion-common/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "vegafusion-common"
version = "2.0.0-rc1"
version = "2.0.0"
edition = "2021"
description = "Common components required by multiple VegaFusion crates"
license = "BSD-3-Clause"
Expand Down
4 changes: 2 additions & 2 deletions vegafusion-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "vegafusion-core"
license = "BSD-3-Clause"
edition = "2021"
version = "2.0.0-rc1"
version = "2.0.0"
description = "Core components required by multiple VegaFusion crates, with WASM compatibility"

[features]
Expand Down Expand Up @@ -51,7 +51,7 @@ features = ["preserve_order"]
[dependencies.vegafusion-common]
path = "../vegafusion-common"
features = ["json", "sqlparser"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.datafusion-common]
workspace = true
Expand Down
8 changes: 4 additions & 4 deletions vegafusion-python/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "vegafusion"
license = "BSD-3-Clause"
edition = "2021"
version = "2.0.0-rc1"
version = "2.0.0"
description = "VegaFusion Python interface"

[lib]
Expand Down Expand Up @@ -47,16 +47,16 @@ workspace = true
[dependencies.vegafusion-common]
path = "../vegafusion-common"
features = ["pyo3", "base64"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-core]
path = "../vegafusion-core"
features = ["py", "tonic_support"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-runtime]
path = "../vegafusion-runtime"
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.tokio]
workspace = true
Expand Down
2 changes: 1 addition & 1 deletion vegafusion-python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "vegafusion"
version = "2.0.0-rc1"
version = "2.0.0"
description = "Core tools for using VegaFusion from Python"
readme = "README.md"
requires-python = ">=3.9"
Expand Down
6 changes: 3 additions & 3 deletions vegafusion-runtime/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ harness = false
name = "vegafusion-runtime"
license = "BSD-3-Clause"
edition = "2021"
version = "2.0.0-rc1"
version = "2.0.0"
description = "VegaFusion Runtime"

[features]
Expand Down Expand Up @@ -100,12 +100,12 @@ workspace = true
[dependencies.vegafusion-common]
path = "../vegafusion-common"
features = ["json", "sqlparser", "prettyprint", "object_store", "url"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-core]
path = "../vegafusion-core"
features = ["sqlparser"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.serde]
version = "1.0.137"
Expand Down
8 changes: 4 additions & 4 deletions vegafusion-server/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ path = "src/main.rs"
[package]
name = "vegafusion-server"
license = "BSD-3-Clause"
version = "2.0.0-rc1"
version = "2.0.0"
edition = "2021"
description = "VegaFusion Server"
repository = "https://github.com/vega/vegafusion"
Expand All @@ -31,16 +31,16 @@ workspace = true

[dependencies.vegafusion-common]
path = "../vegafusion-common"
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-core]
path = "../vegafusion-core"
features = ["tonic_support"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-runtime]
path = "../vegafusion-runtime"
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.tokio]
workspace = true
Expand Down
8 changes: 4 additions & 4 deletions vegafusion-wasm/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "vegafusion-wasm"
license = "BSD-3-Clause"
version = "2.0.0-rc1"
version = "2.0.0"
edition = "2021"
description = "VegaFusion WASM package for embedding Vega charts in the browser with a connection to a VegaFusion Runtime"

Expand Down Expand Up @@ -33,15 +33,15 @@ workspace = true
[dependencies.vegafusion-common]
path = "../vegafusion-common"
features = ["json"]
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-core]
path = "../vegafusion-core"
version = "2.0.0-rc1"
version = "2.0.0"

[dependencies.vegafusion-runtime]
path = "../vegafusion-runtime"
version = "2.0.0-rc1"
version = "2.0.0"
default-features = false
features = ["http-wasm"]

Expand Down
2 changes: 1 addition & 1 deletion vegafusion-wasm/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vegafusion-wasm/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vegafusion-wasm",
"version": "2.0.0-rc1",
"version": "2.0.0",
"author": "Jon Mease <[email protected]> (https://jonmmease.dev)",
"license": "BSD-3-Clause",
"description": "Wasm library for interfacing with VegaFusion",
Expand Down
Loading