feat: rename sparrow-py to kaskada (#659)

- Initial version 0.6.0 is the next minor version since the most recent kaskada release. - Move `/sparrow-py` to `/python` - Change standard import from `import kaskada as kt` to `import kaskada as kd`
kaskada-ai · Aug 11, 2023 · 9a9b793 · 9a9b793
1 parent 50a8196
commit 9a9b793
Show file tree

Hide file tree

Showing 167 changed files with 245 additions and 268 deletions.
diff --git a/sparrow-py/.coveragerc → python/.coveragerc b/sparrow-py/.coveragerc → python/.coveragerc
diff --git a/sparrow-py/.darglint → python/.darglint b/sparrow-py/.darglint → python/.darglint
diff --git a/sparrow-py/.flake8 → python/.flake8 b/sparrow-py/.flake8 → python/.flake8
diff --git a/sparrow-py/Cargo.lock → python/Cargo.lock b/sparrow-py/Cargo.lock → python/Cargo.lock
diff --git a/sparrow-py/Cargo.toml → python/Cargo.toml b/sparrow-py/Cargo.toml → python/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
-name = "sparrow-py"
+name = "kaskada"
 authors = ["Kaskada Developers"]
 edition = "2021"
 license = "Apache-2.0"
-version = "0.1.0"
+version = "0.6.0"
 description = """
-Python library for building and executing Kaskada queries.
+Python library for building and executing temporal queries.
 """
 
 # This needs to be its own workspace.
@@ -24,7 +24,7 @@ tokio = { version = "1.27.0", features = ["sync"] }
 tracing = "0.1.37"
 
 [lib]
-name = "sparrow_py"
+name = "kaskada"
 # `cdylib` is necessary to produce a shared library for Python.
 # This can't be used by downstream Rust code (eg., as a library).
 crate-type = ["cdylib"]
diff --git a/sparrow-py/README.md → python/README.md b/sparrow-py/README.md → python/README.md
diff --git a/sparrow-py/codecov.yml → python/codecov.yml b/sparrow-py/codecov.yml → python/codecov.yml
diff --git a/sparrow-py/docs/.gitignore → python/docs/.gitignore b/sparrow-py/docs/.gitignore → python/docs/.gitignore
diff --git a/...s/source/_extensions/gallery_directive.py → ...s/source/_extensions/gallery_directive.py b/...s/source/_extensions/gallery_directive.py → ...s/source/_extensions/gallery_directive.py
diff --git a/sparrow-py/docs/source/_static/favicon.png → python/docs/source/_static/favicon.png b/sparrow-py/docs/source/_static/favicon.png → python/docs/source/_static/favicon.png
diff --git a/...s/source/_templates/autosummary/class.rst → ...s/source/_templates/autosummary/class.rst b/...s/source/_templates/autosummary/class.rst → ...s/source/_templates/autosummary/class.rst
diff --git a/...ource/_templates/autosummary/function.rst → ...ource/_templates/autosummary/function.rst b/...ource/_templates/autosummary/function.rst → ...ource/_templates/autosummary/function.rst
diff --git a/.../source/_templates/autosummary/method.rst → .../source/_templates/autosummary/method.rst b/.../source/_templates/autosummary/method.rst → .../source/_templates/autosummary/method.rst
diff --git a/sparrow-py/docs/source/concepts.md → python/docs/source/concepts.md b/sparrow-py/docs/source/concepts.md → python/docs/source/concepts.md
diff --git a/sparrow-py/docs/source/conf.py → python/docs/source/conf.py b/sparrow-py/docs/source/conf.py → python/docs/source/conf.py
@@ -7,7 +7,7 @@
 
 sys.path.append(str(Path(".").resolve()))
 
-project = "sparrow-py"
+project = "kaskada"
 author = "Kaskada Contributors"
 copyright = "2023, Kaskada Contributors"
 extensions = [
@@ -38,7 +38,7 @@
     "home_page_in_toc": True,
     "use_issues_button": True,
     "repository_branch": "main",
-    "path_to_docs": "sparrow-py/docs/source",
+    "path_to_docs": "kaskada/docs/source",
     "icon_links": [
         {
             "name": "GitHub",
@@ -63,7 +63,7 @@
     "github_user": "kaskada-ai",
     "github_repo": "kaskada",
     "github_version": "main",
-    "doc_path": "sparrow-py/docs/source",
+    "doc_path": "kaskada/docs/source",
 }
 
 intersphinx_mapping: Dict[str, Any] = {

diff --git a/sparrow-py/docs/source/examples/index.md → python/docs/source/examples/index.md b/sparrow-py/docs/source/examples/index.md → python/docs/source/examples/index.md
diff --git a/sparrow-py/docs/source/guide/introduction.md → python/docs/source/guide/introduction.md b/sparrow-py/docs/source/guide/introduction.md → python/docs/source/guide/introduction.md
diff --git a/sparrow-py/docs/source/index.md → python/docs/source/index.md b/sparrow-py/docs/source/index.md → python/docs/source/index.md
diff --git a/sparrow-py/docs/source/quickstart.md → python/docs/source/quickstart.md b/sparrow-py/docs/source/quickstart.md → python/docs/source/quickstart.md
@@ -15,8 +15,8 @@ Write the quick start.
 ```
 
 ```{code-cell}
-import sparrow_py as kt
-kt.init_session()
+import kaskada as kd
+kd.init_session()
 content = "\n".join(
     [
         "time,key,m,n",
@@ -28,6 +28,6 @@ content = "\n".join(
         "1996-12-19T16:40:02-08:00,A,,",
     ]
 )
-source = kt.sources.CsvString(content, time_column_name="time", key_column_name="key")
+source = kd.sources.CsvString(content, time_column_name="time", key_column_name="key")
 source.run().to_pandas()
 ```
diff --git a/sparrow-py/docs/source/reference/results.md → python/docs/source/reference/results.md b/sparrow-py/docs/source/reference/results.md → python/docs/source/reference/results.md
@@ -1,7 +1,7 @@
 # Results
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: apidocs/

diff --git a/sparrow-py/docs/source/reference/sources.md → python/docs/source/reference/sources.md b/sparrow-py/docs/source/reference/sources.md → python/docs/source/reference/sources.md
@@ -1,7 +1,7 @@
 # Sources
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py.sources
+.. currentmodule:: kaskada.sources
 
 .. autosummary::
    :toctree: apidocs/sources

diff --git a/...ource/reference/timestream/aggregation.md → ...ource/reference/timestream/aggregation.md b/...ource/reference/timestream/aggregation.md → ...ource/reference/timestream/aggregation.md
@@ -10,7 +10,7 @@ Windowed:
     They reflect the values within a specific [window](../windows.md).
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/...source/reference/timestream/arithmetic.md → ...source/reference/timestream/arithmetic.md b/...source/reference/timestream/arithmetic.md → ...source/reference/timestream/arithmetic.md
@@ -9,7 +9,7 @@ See the notes on the specific functions for more information.
 ```
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/...source/reference/timestream/collection.md → ...source/reference/timestream/collection.md b/...source/reference/timestream/collection.md → ...source/reference/timestream/collection.md
@@ -3,7 +3,7 @@
 Timestreams allow each point to contain a collection -- a `list` or `map` -- of elements.
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/...source/reference/timestream/comparison.md → ...source/reference/timestream/comparison.md b/...source/reference/timestream/comparison.md → ...source/reference/timestream/comparison.md
@@ -11,7 +11,7 @@ To respect the semantics of `__eq__` and `__ne__`, `a == b` and `a != b` are *no
 ```
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/.../source/reference/timestream/execution.md → .../source/reference/timestream/execution.md b/.../source/reference/timestream/execution.md → .../source/reference/timestream/execution.md
@@ -1,7 +1,7 @@
 # Execution
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/...s/source/reference/timestream/grouping.md → ...s/source/reference/timestream/grouping.md b/...s/source/reference/timestream/grouping.md → ...s/source/reference/timestream/grouping.md
@@ -1,7 +1,7 @@
 # Grouping
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/...docs/source/reference/timestream/index.md → ...docs/source/reference/timestream/index.md b/...docs/source/reference/timestream/index.md → ...docs/source/reference/timestream/index.md
@@ -1,10 +1,10 @@
 # Timestream
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
-.. autoclass:: sparrow_py.Literal
-.. autoclass:: sparrow_py.Timestream
+.. autoclass:: kaskada.Literal
+.. autoclass:: kaskada.Timestream
     :exclude-members: __init__
 ```
 

diff --git a/...cs/source/reference/timestream/logical.md → ...cs/source/reference/timestream/logical.md b/...cs/source/reference/timestream/logical.md → ...cs/source/reference/timestream/logical.md
@@ -1,7 +1,7 @@
 # Logical
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/.../docs/source/reference/timestream/misc.md → .../docs/source/reference/timestream/misc.md b/.../docs/source/reference/timestream/misc.md → .../docs/source/reference/timestream/misc.md
@@ -1,7 +1,7 @@
 # Miscellaneous
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/...cs/source/reference/timestream/records.md → ...cs/source/reference/timestream/records.md b/...cs/source/reference/timestream/records.md → ...cs/source/reference/timestream/records.md
@@ -4,7 +4,7 @@ Record operations create, extract or manipulate Timestreams of records.
 Comparison operations produce boolean Timestreams.
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/.../docs/source/reference/timestream/time.md → .../docs/source/reference/timestream/time.md b/.../docs/source/reference/timestream/time.md → .../docs/source/reference/timestream/time.md
@@ -1,7 +1,7 @@
 # Time
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py
+.. currentmodule:: kaskada
 
 .. autosummary::
    :toctree: ../apidocs/

diff --git a/sparrow-py/docs/source/reference/windows.md → python/docs/source/reference/windows.md b/sparrow-py/docs/source/reference/windows.md → python/docs/source/reference/windows.md
@@ -1,7 +1,7 @@
 # Windows
 
 ```{eval-rst}
-.. currentmodule:: sparrow_py.windows
+.. currentmodule:: kaskada.windows
 
 .. autosummary::
     :toctree: apidocs/windows/

diff --git a/sparrow-py/mypy.ini → python/mypy.ini b/sparrow-py/mypy.ini → python/mypy.ini
diff --git a/sparrow-py/noxfile.py → python/noxfile.py b/sparrow-py/noxfile.py → python/noxfile.py
@@ -8,7 +8,7 @@
 
 import nox
 
-package = "sparrow_py"
+package = "kaskada"
 python_versions = ["3.11", "3.10", "3.9", "3.8"]
 nox.needs_version = ">= 2021.6.6"
 nox.options.sessions = (
@@ -99,7 +99,7 @@ def coverage(session: nox.Session) -> None:
 @nox.session(python=python_versions[0])
 def typeguard(session: nox.Session) -> None:
     """Runtime type checking using Typeguard."""
-    install(session, groups=["typecheck"])
+    install(session, groups=["typecheck", "test"])
     session.run("pytest", f"--typeguard-packages={package}", *session.posargs)
 
 

diff --git a/sparrow-py/poetry.lock → python/poetry.lock b/sparrow-py/poetry.lock → python/poetry.lock
diff --git a/sparrow-py/pyproject.toml → python/pyproject.toml b/sparrow-py/pyproject.toml → python/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
-name = "sparrow_py"
-version = "0.1.0"
+name = "kaskada"
+version = "0.6.0"
 description = "Kaskada query builder and local execution engine."
 authors = []
 
@@ -78,7 +78,7 @@ requires = ["maturin>=1,<2"]
 build-backend = "maturin"
 
 [project]
-name = "sparrow_py"
+name = "kaskada"
 version = "0.1.0"
 description = "Kaskada query builder and local execution engine."
 requires-python = ">=3.8,<4.0"
@@ -90,7 +90,7 @@ profile = "release"
 # Path to the python source directory
 python-source = "pysrc"
 # Name of the Rust module in Python
-module-name = "sparrow_py._ffi"
+module-name = "kaskada._ffi"
 
 [tool.coverage.paths]
 source = ["pysrc", "*/site-packages"]

diff --git a/sparrow-py/pysrc/sparrow_py/__init__.py → python/pysrc/kaskada/__init__.py b/sparrow-py/pysrc/sparrow_py/__init__.py → python/pysrc/kaskada/__init__.py
diff --git a/sparrow-py/pysrc/sparrow_py/_execution.py → python/pysrc/kaskada/_execution.py b/sparrow-py/pysrc/sparrow_py/_execution.py → python/pysrc/kaskada/_execution.py
diff --git a/sparrow-py/pysrc/sparrow_py/_ffi.pyi → python/pysrc/kaskada/_ffi.pyi b/sparrow-py/pysrc/sparrow_py/_ffi.pyi → python/pysrc/kaskada/_ffi.pyi
diff --git a/sparrow-py/pysrc/sparrow_py/_result.py → python/pysrc/kaskada/_result.py b/sparrow-py/pysrc/sparrow_py/_result.py → python/pysrc/kaskada/_result.py
diff --git a/sparrow-py/pysrc/sparrow_py/_session.py → python/pysrc/kaskada/_session.py b/sparrow-py/pysrc/sparrow_py/_session.py → python/pysrc/kaskada/_session.py
@@ -2,7 +2,7 @@
 
 from typing import Optional
 
-from sparrow_py import _ffi
+from kaskada import _ffi
 
 
 _SESSION: Optional[_ffi.Session] = None