egglog 7.1.0__tar.gz → 8.0.0__tar.gz

{egglog-7.1.0 → egglog-8.0.0}/.github/dependabot.yml

@@ -9,11 +9,26 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      rust-production:
+        dependency-type: "production"
+      rust-development:
+        dependency-type: "development"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      actions-production:
+        dependency-type: "production"
+      actions-development:
+        dependency-type: "development"
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      python-production:
+        dependency-type: "production"
+      python-development:
+        dependency-type: "development"

{egglog-7.1.0 → egglog-8.0.0}/.github/workflows/version.yml

@@ -53,6 +53,8 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: version-${{ needs.bump.outputs.version }}
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v1
       - uses: PyO3/maturin-action@v1.42.1
         with:
           manylinux: auto
@@ -93,7 +95,8 @@ jobs:
       - uses: PyO3/maturin-action@v1.42.1
         with:
           command: build
-          args: --release -o dist --universal2 --find-interpreter
+          target: universal2-apple-darwin
+          args: --release -o dist --find-interpreter
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -128,7 +131,7 @@ jobs:
       - run: |
           git tag "v$VERSION"
           git push --tags
-          gh pr merge --admin --delete-branch
+          gh pr merge --admin --delete-branch --merge
         env:
           VERSION: ${{ needs.bump.outputs.version }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{egglog-7.1.0 → egglog-8.0.0}/.gitignore

@@ -83,3 +83,5 @@ Source.*
 3
 4
 inlined
+visualizer.tgz
+package

{egglog-7.1.0 → egglog-8.0.0}/Cargo.lock

@@ -135,6 +135,15 @@ version = "2.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b4682ae6287fcf752ecaabbfcc7b6f9b72aa33933dc23a554d853aea8eea8635"
 
+[[package]]
+name = "bitmaps"
+version = "2.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "031043d04099746d8db04daf1fa424b2bc8bd69d92b25962dcde24da39ab64a2"
+dependencies = [
+ "typenum",
+]
+
 [[package]]
 name = "block-buffer"
 version = "0.10.4"
@@ -144,6 +153,12 @@ dependencies = [
  "generic-array",
 ]
 
+[[package]]
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
 [[package]]
 name = "cc"
 version = "1.0.83"
@@ -284,14 +299,15 @@ checksum = "675e35c02a51bb4d4618cb4885b3839ce6d1787c97b664474d9208d074742e20"
 
 [[package]]
 name = "egglog"
-version = "0.1.0"
-source = "git+https://github.com/egraphs-good/egglog?rev=fb4a9f114f9bb93154d6eff0dbab079b5cb4ebb6#fb4a9f114f9bb93154d6eff0dbab079b5cb4ebb6"
+version = "0.2.0"
+source = "git+https://github.com/saulshanabrook/egg-smol?rev=a555b2f5e82c684442775cc1a5da94b71930113c#a555b2f5e82c684442775cc1a5da94b71930113c"
 dependencies = [
  "clap",
  "egraph-serialize",
  "env_logger",
  "generic_symbolic_expressions",
  "hashbrown 0.14.1",
+ "im-rc",
  "indexmap",
  "instant",
  "lalrpop",
@@ -311,8 +327,8 @@ dependencies = [
 ]
 
 [[package]]
-name = "egglog-python"
-version = "7.1.0"
+name = "egglog_python"
+version = "8.0.0"
 dependencies = [
  "egglog",
  "egraph-serialize",
@@ -329,7 +345,7 @@ dependencies = [
 [[package]]
 name = "egraph-serialize"
 version = "0.1.0"
-source = "git+https://github.com/egraphs-good/egraph-serialize?rev=5838c036623e91540831745b1574539e01c8cb23#5838c036623e91540831745b1574539e01c8cb23"
+source = "git+https://github.com/saulshanabrook/egraph-serialize?rev=1c205fcc6d3426800b828e9264dbadbd4a5ef6e9#1c205fcc6d3426800b828e9264dbadbd4a5ef6e9"
 dependencies = [
  "graphviz-rust",
  "indexmap",
@@ -396,9 +412,9 @@ dependencies = [
 
 [[package]]
 name = "fastrand"
-version = "2.0.1"
+version = "2.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "25cbce373ec4653f1a01a31e8a5e5ec0c622dc27ff9c4e6606eefef5cbbed4a5"
+checksum = "9fc0510504f03c51ada170672ac806f1f105a88aa97a5281117e1ddc3368e51a"
 
 [[package]]
 name = "fixedbitset"
@@ -418,8 +434,9 @@ dependencies = [
 
 [[package]]
 name = "generic_symbolic_expressions"
-version = "5.0.3"
-source = "git+https://github.com/oflatt/symbolic-expressions?rev=655b6a4c06b4b3d3b2300e17779860b4abe440f0#655b6a4c06b4b3d3b2300e17779860b4abe440f0"
+version = "5.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "597eb584fb7cfd1935294fc3608a453fc35a58dfa9da4299c8fd3bc75a4c0b4b"
 
 [[package]]
 name = "getrandom"
@@ -485,6 +502,20 @@ version = "2.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"
 
+[[package]]
+name = "im-rc"
+version = "15.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "af1955a75fa080c677d3972822ec4bad316169ab1cfc6c257a942c2265dbe5fe"
+dependencies = [
+ "bitmaps",
+ "rand_core",
+ "rand_xoshiro",
+ "sized-chunks",
+ "typenum",
+ "version_check",
+]
+
 [[package]]
 name = "indexmap"
 version = "2.2.6"
@@ -730,9 +761,9 @@ dependencies = [
 
 [[package]]
 name = "pest"
-version = "2.7.4"
+version = "2.7.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c022f1e7b65d6a24c0dbbd5fb344c66881bc01f3e5ae74a1c8100f2f985d98a4"
+checksum = "cd53dff83f26735fdc1ca837098ccf133605d794cdae66acfc2bfac3ec809d95"
 dependencies = [
  "memchr",
  "thiserror",
@@ -741,9 +772,9 @@ dependencies = [
 
 [[package]]
 name = "pest_derive"
-version = "2.7.4"
+version = "2.7.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "35513f630d46400a977c4cb58f78e1bfbe01434316e60c37d27b9ad6139c66d8"
+checksum = "2a548d2beca6773b1c244554d36fcf8548a8a58e74156968211567250e48e49a"
 dependencies = [
  "pest",
  "pest_generator",
@@ -751,9 +782,9 @@ dependencies = [
 
 [[package]]
 name = "pest_generator"
-version = "2.7.4"
+version = "2.7.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bc9fc1b9e7057baba189b5c626e2d6f40681ae5b6eb064dc7c7834101ec8123a"
+checksum = "3c93a82e8d145725dcbaf44e5ea887c8a869efdcc28706df2d08c69e17077183"
 dependencies = [
  "pest",
  "pest_meta",
@@ -764,9 +795,9 @@ dependencies = [
 
 [[package]]
 name = "pest_meta"
-version = "2.7.4"
+version = "2.7.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1df74e9e7ec4053ceb980e7c0c8bd3594e977fde1af91daba9c928e8e8c6708d"
+checksum = "a941429fea7e08bedec25e4f6785b6ffaacc6b755da98df5ef3e7dcf4a124c4f"
 dependencies = [
  "once_cell",
  "pest",
@@ -806,9 +837,12 @@ checksum = "7170ef9988bc169ba16dd36a7fa041e5c4cbeb6a35b76d4c03daded371eae7c0"
 
 [[package]]
 name = "ppv-lite86"
-version = "0.2.17"
+version = "0.2.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de"
+checksum = "77957b295656769bb8ad2b6a6b09d897d94f05c41b069aede1fcdaa675eaea04"
+dependencies = [
+ "zerocopy",
+]
 
 [[package]]
 name = "precomputed-hash"
@@ -940,6 +974,15 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "rand_xoshiro"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6f97cdb2a36ed4183de61b2f824cc45c9f1037f28afe0a322e9fff4c108b5aaa"
+dependencies = [
+ "rand_core",
+]
+
 [[package]]
 name = "redox_syscall"
 version = "0.2.16"
@@ -1090,6 +1133,16 @@ version = "0.3.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "38b58827f4464d87d377d175e90bf58eb00fd8716ff0a62f80356b5e61555d0d"
 
+[[package]]
+name = "sized-chunks"
+version = "0.6.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "16d69225bde7a69b235da73377861095455d298f2b970996eec25ddbb42b3d1e"
+dependencies = [
+ "bitmaps",
+ "typenum",
+]
+
 [[package]]
 name = "smallvec"
 version = "1.11.0"
@@ -1368,3 +1421,24 @@ name = "windows_x86_64_msvc"
 version = "0.48.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a"
+
+[[package]]
+name = "zerocopy"
+version = "0.7.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0"
+dependencies = [
+ "byteorder",
+ "zerocopy-derive",
+]
+
+[[package]]
+name = "zerocopy-derive"
+version = "0.7.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.60",
+]

egglog-8.0.0/Cargo.toml

@@ -0,0 +1,42 @@
+[package]
+name = "egglog_python"
+version = "8.0.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+name = "egglog"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.21", features = ["extension-module"] }
+
+# https://github.com/egraphs-good/egglog/compare/ceed816e9369570ffed9feeba157b19471dda70d...main
+# egglog = { git = "https://github.com/egraphs-good/egglog", rev = "fb4a9f114f9bb93154d6eff0dbab079b5cb4ebb6" }
+# egglog = { path = "../egg-smol" }
+# egglog = { git = "https://github.com/oflatt/egg-smol", branch = "oflatt-fast-terms" }
+egglog = { git = "https://github.com/saulshanabrook/egg-smol", rev = "a555b2f5e82c684442775cc1a5da94b71930113c" }
+egraph-serialize = { git = "https://github.com/saulshanabrook/egraph-serialize", rev = "1c205fcc6d3426800b828e9264dbadbd4a5ef6e9", features = [
+    "serde",
+    "graphviz",
+] }
+# egraph-serialize = { path = "../egraph-serialize", features = [
+#     "serde",
+#     "graphviz",
+# ] }
+serde_json = "*"
+pyo3-log = "0.10.0"
+log = "0.4.21"
+lalrpop-util = { version = "0.20.2", features = ["lexer"] }
+ordered-float = "*"
+uuid = { version = "1.8.0", features = ["v4"] }
+num-rational = "*"
+
+# Use unreleased version of egraph-serialize in egglog as well
+# [patch.crates-io]
+# egraph-serialize = { git = "https://github.com/egraphs-good/egraph-serialize", rev = "5838c036623e91540831745b1574539e01c8cb23" }
+# egraph-serialize = { path = "../egraph-serialize" }
+
+# enable debug symbols for easier profiling
+# [profile.release]
+# debug = 1

egglog-8.0.0/Makefile

@@ -0,0 +1,24 @@
+
+all: python/egglog/visualizer.js
+
+
+
+# download visualizer release from github
+#
+visualizer.tgz:
+	curl -s https://api.github.com/repos/egraphs-good/egraph-visualizer/releases/latest \
+	| grep "browser_download_url.*tgz" \
+	| cut -d : -f 2,3 \
+	| tr -d \" \
+	| wget -qi - -O visualizer.tgz
+
+# extract visualizer release
+python/egglog/visualizer.js python/egglog/visualizer.css: visualizer.tgz
+	tar -xzf visualizer.tgz
+	rm visualizer.tgz
+	mv package/dist/index.js python/egglog/visualizer.js
+	mv package/dist/style.css python/egglog/visualizer.css
+	rm -rf package
+
+clean:
+	rm -rf package python/egglog/visualizer.css python/egglog/visualizer.js visualizer.tgz

{egglog-7.1.0 → egglog-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: egglog
-Version: 7.1.0
+Version: 8.0.0
 Classifier: Environment :: MacOS X
 Classifier: Environment :: Win32 (MS Windows)
 Classifier: Intended Audience :: Developers
@@ -19,38 +19,39 @@ Classifier: Typing :: Typed
 Requires-Dist: typing-extensions
 Requires-Dist: black
 Requires-Dist: graphviz
-Requires-Dist: pytest; extra == 'test'
-Requires-Dist: mypy; extra == 'test'
-Requires-Dist: syrupy; extra == 'test'
-Requires-Dist: egglog[array]; extra == 'test'
-Requires-Dist: pytest-codspeed; extra == 'test'
-Requires-Dist: pytest-benchmark; extra == 'test'
-Requires-Dist: pytest-xdist; extra == 'test'
-Requires-Dist: scikit-learn; extra == 'array'
-Requires-Dist: array_api_compat; extra == 'array'
-Requires-Dist: numba==0.59.1; extra == 'array'
-Requires-Dist: llvmlite==0.42.0; extra == 'array'
-Requires-Dist: pydata-sphinx-theme; extra == 'docs'
-Requires-Dist: myst-nb; extra == 'docs'
-Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
-Requires-Dist: sphinx-gallery; extra == 'docs'
-Requires-Dist: nbconvert; extra == 'docs'
-Requires-Dist: matplotlib; extra == 'docs'
-Requires-Dist: anywidget; extra == 'docs'
-Requires-Dist: seaborn; extra == 'docs'
-Requires-Dist: egglog[array]; extra == 'docs'
-Requires-Dist: line-profiler; extra == 'docs'
-Requires-Dist: sphinxcontrib-mermaid; extra == 'docs'
-Requires-Dist: ablog; extra == 'docs'
-Requires-Dist: pre-commit; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: anywidget[dev]; extra == 'dev'
-Requires-Dist: egglog[docs,test]; extra == 'dev'
-Provides-Extra: test
+Requires-Dist: anywidget
+Requires-Dist: scikit-learn ; extra == 'array'
+Requires-Dist: array-api-compat ; extra == 'array'
+Requires-Dist: numba ==0.59.1 ; extra == 'array'
+Requires-Dist: llvmlite ==0.42.0 ; extra == 'array'
+Requires-Dist: pre-commit ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: mypy ; extra == 'dev'
+Requires-Dist: anywidget[dev] ; extra == 'dev'
+Requires-Dist: egglog[docs,test] ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
+Requires-Dist: syrupy ; extra == 'test'
+Requires-Dist: egglog[array] ; extra == 'test'
+Requires-Dist: pytest-codspeed ; extra == 'test'
+Requires-Dist: pytest-benchmark ; extra == 'test'
+Requires-Dist: pytest-xdist ; extra == 'test'
+Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
+Requires-Dist: myst-nb ; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
+Requires-Dist: sphinx-gallery ; extra == 'docs'
+Requires-Dist: nbconvert ; extra == 'docs'
+Requires-Dist: matplotlib ; extra == 'docs'
+Requires-Dist: anywidget ; extra == 'docs'
+Requires-Dist: seaborn ; extra == 'docs'
+Requires-Dist: egglog[array] ; extra == 'docs'
+Requires-Dist: line-profiler ; extra == 'docs'
+Requires-Dist: sphinxcontrib-mermaid ; extra == 'docs'
+Requires-Dist: ablog ; extra == 'docs'
 Provides-Extra: array
-Provides-Extra: docs
 Provides-Extra: dev
+Provides-Extra: test
+Provides-Extra: docs
 License-File: LICENSE
 Summary: e-graphs in Python built around the the egglog rust library
 License: MIT

{egglog-7.1.0 → egglog-8.0.0}/docs/changelog.md

@@ -4,6 +4,21 @@ _This project uses semantic versioning_
 
 ## UNRELEASED
 
+## 8.0.0 (2024-10-17)
+
+- Adds ability to use anonymous functions where callables are needed. These are automatically transformed to egglog
+  functions with default rewrites.
+- Upgrade [egglog](https://github.com/egraphs-good/egglog/compare/fb4a9f114f9bb93154d6eff0dbab079b5cb4ebb6...saulshanabrook:egg-smol:a555b2f5e82c684442775cc1a5da94b71930113c)
+  - Adds source annotations to expressions for tracebacks
+  - Adds ability to inline other functions besides primitives in serialized output
+- Adds `remove` and `set` methods to `Vec`
+- Upgrades to use the new egraph-visualizer so we can have interactive visualizations
+
+## 7.2.0 (2024-05-23)
+
+- Adds ability to use function bodies as default rewrites ([#167](https://github.com/egraphs-good/egglog-python/pull/167))
+- Fixed bug with creating empty maps and adding to maps ([#168](https://github.com/egraphs-good/egglog-python/pull/168))
+
 ## 7.1.0 (2024-05-03)
 
 ## New Feaatures

{egglog-7.1.0 → egglog-8.0.0}/docs/conf.py

@@ -72,6 +72,14 @@ extensions = [
 ]
 
 
+##
+# Intersphinx
+##
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+
 ##
 # Sphinx Gallery
 # https://sphinx-gallery.github.io/stable/configuration.html#build-pattern

{egglog-7.1.0 → egglog-8.0.0}/docs/index.md

@@ -2,9 +2,9 @@
 file_format: mystnb
 ---
 
-# [`egglog`](https://github.com/egraphs-good/egglog/) Python
+# `egglog` Python
 
-`egglog` is a Python package that provides bindings to the Rust library of the same name,
+`egglog` is a Python package that provides bindings to [the Rust library of the same name](https://github.com/egraphs-good/egglog/),
 allowing you to use e-graphs in Python for optimization, symbolic computation, and analysis.
 
 It wraps the Rust library [`egglog`](https://github.com/egraphs-good/egglog) which
@@ -13,14 +13,10 @@ See the ["Better Together: Unifying Datalog and Equality Saturation"](https://ar
 
 > We present egglog, a fixpoint reasoning system that unifies Datalog and equality saturation (EqSat). Like Datalog, it supports efficient incremental execution, cooperating analyses, and lattice-based reasoning. Like EqSat, it supports term rewriting, efficient congruence closure, and extraction of optimized terms.
 
-## [Installation](./reference/usage)
-
 ```shell
 pip install egglog
 ```
 
-## Example
-
 ```{code-cell} python
 from __future__ import annotations
 from egglog import *
@@ -49,15 +45,10 @@ def _num_rule(a: Num, b: Num, c: Num, i: i64, j: i64):
     yield rewrite(Num(i) * Num(j)).to(Num(i * j))
 
 egraph.saturate()
-```
-
-```{code-cell} python
 egraph.check(eq(expr1).to(expr2))
 egraph.extract(expr1)
 ```
 
-## Contents
-
 ```{toctree}
 :maxdepth: 2
 tutorials

egglog-8.0.0/docs/reference/contributing.md

@@ -0,0 +1,94 @@
+# Contributing
+
+## Development
+
+This package is in active development and welcomes contributions!
+
+Feel free to bring up any questions/comments on [the Zulip chat](https://egraphs.zulipchat.com/) or open an issue.
+
+All feedback is welcome and encouraged, it's great to hear about anything that works well or could be improved.
+
+### Getting Started
+
+To get started locally developing with this project, fork it and clone it to your local machine.
+
+Using [the Github CLI](https://github.com/cli/cli#installation) this would be:
+
+```bash
+brew install gh
+gh repo fork egraphs-good/egglog-python --clone
+cd egglog-python
+```
+
+Then [install Rust](https://www.rust-lang.org/tools/install) and get a Python environment set up with a compatible version. Using [miniconda](https://formulae.brew.sh/cask/miniconda) this would be:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+brew install --cask miniconda
+conda create -n egglog-python python
+conda activate egglog-python
+```
+
+Then install the package in editable mode with the development dependencies:
+
+```bash
+maturin develop -E dev,docs,test,array
+```
+
+Anytime you change the rust code, you can run `maturin develop -E` to recompile the rust code.
+
+If you would like to download a new version of the visualizer source, run `make clean; make`. This will download
+the most recent released version from the github actions artifact in the [egraph-visualizer](https://github.com/egraphs-good/egraph-visualizer) repo. It is checked in because it's a pain to get cargo to include only one git ignored file while ignoring the rest of the files that were ignored.
+
+### Running Tests
+
+To run the tests, you can use the `pytest` command:
+
+```bash
+pytest
+```
+
+All code must pass ruff linters and formaters. This will be checked automatically by the pre-commit if you run `pre-commit install`.
+
+To run it manually, you can use:
+
+```bash
+pre-commit run --all-files ruff
+```
+
+If you make changes to the rust bindings, you can check that the stub files accurately reflect the rust code by running:
+
+```bash
+pre-commit run --all-files --hook-stage manual stubtest
+```
+
+All code must all pass MyPy type checking. To run that locally use:
+
+```bash
+pre-commit run --all-files --hook-stage manual mypy
+```
+
+Finally, to build the docs locally and test that they work, you can run:
+
+```bash
+pre-commit run --all-files --hook-stage manual docs
+```
+
+## Making changes
+
+All changes that impact users should be documented in the `docs/changelog.md` file. Please also add tests for any new features
+or bug fixes.
+
+When you are ready to submit your changes, please open a pull request. The CI will run the tests and check the code style.
+
+## Documentation
+
+We use the [Diátaxis framework](https://diataxis.fr/) to organize our documentation. The "explanation" section has
+been renamed to "Blog" since most of the content there is more like a blog post than a reference manual. It uses
+the [ABlog](https://ablog.readthedocs.io/en/stable/index.html#how-it-works) extension.
+
+## Governance
+
+The governance is currently informal, with Saul Shanabrook as the lead maintainer. If the project grows and there
+are more contributors, we will formalize the governance structure in a way to allow it to be multi-stakeholder and
+to spread out the power and responsibility.