feat: initial commit

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: pytest-coverage-comment
+
+on: [pull_request]
+
+permissions:
+  contents: write
+  checks: write
+  pull-requests: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Fetching base branch
+        run: |
+            git fetch -u origin ${{ github.head_ref }}:${{ github.head_ref }}
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.12
+
+      - name: Set up Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools setuptools-rust
+          pip install '.[dev]'
+      - name: Build Docs
+        run: |
+          nbdev_docs
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ github.token }}
+          force_orphan: true
+          publish_dir: ./_docs
+          # The following lines assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/proto_lint.yml

@@ -0,0 +1,20 @@
+name: proto_lint
+
+on: [pull_request]
+
+jobs:
+  proto_lint:
+    name: proto lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wizhi/setup-buf@v1
+        with:
+          version: '1.43.0'
+
+      - name: Fetching base branch
+        run: |
+            git fetch -u origin ${{ github.head_ref }}:${{ github.head_ref }}
+      - name: Running linter, checking breaking changes
+        run: |
+          buf lint

.github/workflows/rust_lint.yml

@@ -0,0 +1,27 @@
+name: rust_lint
+
+on: [pull_request]
+
+jobs:
+  rust_lint:
+    name: rust lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Fetching base branch
+        run: |
+            git fetch -u origin ${{ github.head_ref }}:${{ github.head_ref }}
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+
+      - uses: rust-marker/marker@v0.5
+        with:
+          install-only: true
+
+      - name: Rust Lint
+        run: |
+          cargo generate-lockfile
+          sed -i 's/version = 4/version = 3/g' ./Cargo.lock
+          cargo marker check -- -p spannerflow_rust -p rust_span --release
+          cargo clippy -p spannerflow_rust -p rust_span --release
+        working-directory: ./spannerflow

.gitignore

@@ -1,3 +1,166 @@
+.ruff_cache
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
 # Generated by Cargo
 # will have compiled files and executables
 debug/
@@ -12,3 +175,29 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+
+# Added by cargo
+/target
+generated_rust
+.DS_Store
+spannerflow/logs
+spannerflow/rust_grpc_server
+spannerflow/rust_lib/src/latest.rs
+protoc/
+rust/
+.vscode/
+pytest.xml
+pytest-coverage.txt
+_proc/
+_docs/
+.quarto
+
+.gitattributes
+.gitconfig
+
+# Quarto installer
+.deb
+.pkg
+
+.last_checked

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+  - repo: https://github.com/fastai/nbdev
+    rev: 2.3.31
+    hooks:
+    - id: nbdev_clean
+      additional_dependencies:
+        - "setuptools"
+    - id: nbdev_export
+      additional_dependencies:
+        - "setuptools"
+        - "black"
+
+
+  - repo: https://github.com/nbQA-dev/nbQA
+    rev: 1.8.7
+    hooks:
+      - id: nbqa-mypy
+        exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$|setup.py'
+        additional_dependencies:
+          - "mypy"
+          - "types-requests"
+      - id: nbqa-black
+        exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$|setup.py'
+      - id: nbqa-isort
+        exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$|setup.py'
+      # - id: nbqa-ruff
+        # exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$|setup.py'
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.13.0'
+    hooks:
+      - id: mypy
+        language: system
+        entry: mypy
+        args: [
+            "--config-file=pyproject.toml"
+        ]
+
+
+  # - repo: https://github.com/pre-commit/mirrors-isort
+  #   rev: 'v5.10.1'
+  #   hooks:
+  #     - id: isort
+  #       exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$'
+
+
+  # - repo: https://github.com/psf/black-pre-commit-mirror
+  #   rev: '24.10.0'
+  #   hooks:
+  #     - id: black
+  #       exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$'
+  #       language_version: python3
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.7.1'
+    hooks:
+    - id: ruff
+      exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$'
+    # - id: ruff-format
+    #  exclude: '.*_pb2\.pyi$|.*_pb2\.py$|.*_pb2_grpc\.py$'
+
+  - repo: https://github.com/bufbuild/buf
+    rev: v1.45.0
+    hooks:
+      - id: buf-lint
+        args: [spannerflow/proto/dataflow/v1/dataflow.proto]