volas 0.0.0__tar.gz

volas-0.0.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+/dist
+/build
+
+# Compiled extensions
+*.so
+*.pyd
+*.dll
+
+# Rust
+/target
+Cargo.lock
+
+# Testing / coverage
+/.pytest_cache
+/.coverage
+.coverage.*
+htmlcov/
+/.benchmarks
+
+# Tooling caches
+/.ruff_cache
+/.mypy_cache
+
+# OS / editor
+.DS_Store
+._*
+.idea/
+.vscode/
+*.swp

volas-0.0.0/Cargo.lock

@@ -0,0 +1,173 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8970a78afe0628a3e3430376fc5fd76b6b45c4d43360ffd6cdd40bdde72b682a"
+dependencies = [
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "458eb0c55e7ece017adeba38f2248ff3ac615e53660d7c71a238d7d2a01c7598"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7114fe5457c61b276ab77c5055f206295b812608083644a5c5b2640c3102565c"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a8725c0a622b374d6cb051d11a0983786448f7785336139c3c94f5aa6bef7e50"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.25.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4109984c22491085343c05b0dbc54ddc405c3cf7b4374fc533f5c3313a572ccc"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
+
+[[package]]
+name = "volas_rs"
+version = "0.0.0"
+dependencies = [
+ "pyo3",
+]

volas-0.0.0/Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+name = "volas_rs"
+version = "0.0.0"
+edition = "2021"
+authors = ["Kael Zhang <i+pypi@kael.me>"]
+description = "High-performance Rust core for the volas time-series kernel"
+license = "MIT"
+homepage = "https://github.com/kaelzhang/volas"
+repository = "https://github.com/kaelzhang/volas"
+readme = "README.md"
+
+[lib]
+name = "volas_rs"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.25", features = ["extension-module"] }
+
+[features]
+default = []
+# Enable this feature to skip building the extension module
+extension-module = ["pyo3/extension-module"]
+
+[profile.release]
+lto = true
+codegen-units = 1
+opt-level = 3

volas-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kael Zhang and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

volas-0.0.0/Makefile

@@ -0,0 +1,91 @@
+files = volas test *.py
+test_files = *
+
+.PHONY: install install-rust build build-pkg build-ext clean test lint fix fmt check cargo-test upload publish dev ci
+
+# Install all dependencies (Python + Rust)
+install:
+	@echo "\033[1m>> Installing Rust toolchain... <<\033[0m"
+	@which rustup > /dev/null || curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+	@rustup update stable
+	@echo "\033[1m>> Installing maturin... <<\033[0m"
+	@pip install maturin
+	@echo "\033[1m>> Installing Python dependencies... <<\033[0m"
+	@pip install -e .[dev]
+
+# Install only the Rust toolchain
+install-rust:
+	@which rustup > /dev/null || curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+	@rustup update stable
+
+# Build the Rust extension and install the package in-place (development)
+build: clean
+	@echo "\033[1m>> Building Rust extension... <<\033[0m"
+	@maturin develop --release
+	@echo "\033[1m>> Build complete! <<\033[0m"
+
+# Build the release package (wheel and sdist) into dist/
+build-pkg: clean
+	@echo "\033[1m>> Building release package... <<\033[0m"
+	@maturin build --release --sdist -o dist
+	@echo "\033[1m>> Package built in dist/ <<\033[0m"
+
+# Build the Rust extension only (development mode)
+build-ext:
+	@maturin develop
+
+# Clean build artifacts
+clean:
+	rm -rf dist build target/wheels
+	rm -rf volas/*.so volas_rs/*.so
+	rm -rf *.egg-info
+	rm -rf .eggs
+	rm -rf .coverage .coverage.* htmlcov
+	find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete 2>/dev/null || true
+
+# Run tests
+test:
+	pytest -s -v test/test_$(test_files).py --doctest-modules --cov volas --cov-report term-missing
+
+# Run linters
+lint:
+	@echo "\033[1m>> Running ruff... <<\033[0m"
+	@ruff check $(files)
+	@echo "\033[1m>> Running mypy... <<\033[0m"
+	@mypy $(files)
+	@echo "\033[1m>> Running cargo check... <<\033[0m"
+	@cargo check
+
+# Auto-fix lint issues
+fix:
+	ruff check --fix $(files)
+	cargo fmt
+
+# Format Rust code
+fmt:
+	cargo fmt
+
+# Check Rust code
+check:
+	cargo check
+	cargo clippy
+
+# Run Rust unit tests
+cargo-test:
+	cargo test
+
+# Upload to PyPI
+upload:
+	twine upload --config-file ~/.pypirc -r pypi dist/* --verbose
+
+# Publish (build package + upload)
+publish:
+	make build-pkg
+	make upload
+
+# Development workflow: build and test
+dev: build test
+
+# Full CI check
+ci: lint cargo-test test

volas-0.0.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: volas
+Version: 0.0.0
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 1 - Planning
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: coverage ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: pytest-benchmark ; extra == 'dev'
+Requires-Dist: twine ; extra == 'dev'
+Requires-Dist: packaging>=24.2 ; extra == 'dev'
+Requires-Dist: numpy>=2.0.0 ; extra == 'dev'
+Requires-Dist: mypy ; extra == 'dev'
+Requires-Dist: maturin>=1.4 ; extra == 'dev'
+Provides-Extra: dev
+License-File: LICENSE
+Summary: High-performance, Rust-backed columnar kernel for stock / candlestick (OHLCV) time-series data.
+Home-Page: https://github.com/kaelzhang/volas
+Author-email: Kael Zhang <i+pypi@kael.me>
+License-Expression: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/kaelzhang/volas
+
+# volas
+
+> High-performance, Rust-backed columnar kernel for stock / candlestick (OHLCV) time-series data.
+
+**Status:** early development — version `0.0.0`. APIs are not yet stable and may change at any time.
+
+## What is volas?
+
+`volas` is a focused, DataFrame-like data structure purpose-built for financial
+candlestick (OHLCV) time series and quantitative-trading workflows.
+
+Rather than being a general-purpose DataFrame, `volas` supports only what this
+domain needs — a time-indexed, two-dimensional table of numeric and boolean
+columns — and implements its storage and compute core in **Rust** for low,
+predictable latency on incremental ("append one bar") workloads.
+
+### Goals
+
+- **Live-trading first** — optimized for the incremental hot path: append a new
+  bar, update indicators, read the result, with minimal per-bar latency.
+- **Small, regular data model** — a time index plus 2-D columns of numbers and
+  booleans; no multi-level indexes, no heterogeneous storage, no general-purpose
+  reshaping.
+- **Rust core** — storage and computation live in a compiled Rust extension.
+- **First-class NumPy interop** — zero-copy `to_numpy` export, designed so data
+  flows cheaply into NumPy and `torch.Tensor` for both training and inference.
+
+## Installation
+
+> Not yet published to PyPI. For a local build, see [Development](#development).
+
+```sh
+pip install volas
+```
+
+Requires Python >= 3.11.
+
+## Usage
+
+> Preview of the intended API. Not yet implemented at `0.0.0`; subject to change.
+
+```py
+from volas import Volas
+
+v = Volas({
+    'open':   [...],
+    'high':   [...],
+    'low':    [...],
+    'close':  [...],
+    'volume': [...],
+})
+
+# Zero-copy export to NumPy (where possible)
+close = v['close'].to_numpy()
+matrix = v.to_numpy()
+```
+
+## Development
+
+Requires Python >= 3.11 and a Rust toolchain.
+
+```sh
+# Build the Rust extension and install the package in-place (development)
+make build
+
+# Build a release wheel + sdist into dist/
+make build-pkg
+
+# Publish to PyPI (build + upload)
+make publish
+```
+
+## License
+
+[MIT](LICENSE)
+

volas-0.0.0/README.md

@@ -0,0 +1,75 @@
+# volas
+
+> High-performance, Rust-backed columnar kernel for stock / candlestick (OHLCV) time-series data.
+
+**Status:** early development — version `0.0.0`. APIs are not yet stable and may change at any time.
+
+## What is volas?
+
+`volas` is a focused, DataFrame-like data structure purpose-built for financial
+candlestick (OHLCV) time series and quantitative-trading workflows.
+
+Rather than being a general-purpose DataFrame, `volas` supports only what this
+domain needs — a time-indexed, two-dimensional table of numeric and boolean
+columns — and implements its storage and compute core in **Rust** for low,
+predictable latency on incremental ("append one bar") workloads.
+
+### Goals
+
+- **Live-trading first** — optimized for the incremental hot path: append a new
+  bar, update indicators, read the result, with minimal per-bar latency.
+- **Small, regular data model** — a time index plus 2-D columns of numbers and
+  booleans; no multi-level indexes, no heterogeneous storage, no general-purpose
+  reshaping.
+- **Rust core** — storage and computation live in a compiled Rust extension.
+- **First-class NumPy interop** — zero-copy `to_numpy` export, designed so data
+  flows cheaply into NumPy and `torch.Tensor` for both training and inference.
+
+## Installation
+
+> Not yet published to PyPI. For a local build, see [Development](#development).
+
+```sh
+pip install volas
+```
+
+Requires Python >= 3.11.
+
+## Usage
+
+> Preview of the intended API. Not yet implemented at `0.0.0`; subject to change.
+
+```py
+from volas import Volas
+
+v = Volas({
+    'open':   [...],
+    'high':   [...],
+    'low':    [...],
+    'close':  [...],
+    'volume': [...],
+})
+
+# Zero-copy export to NumPy (where possible)
+close = v['close'].to_numpy()
+matrix = v.to_numpy()
+```
+
+## Development
+
+Requires Python >= 3.11 and a Rust toolchain.
+
+```sh
+# Build the Rust extension and install the package in-place (development)
+make build
+
+# Build a release wheel + sdist into dist/
+make build-pkg
+
+# Publish to PyPI (build + upload)
+make publish
+```
+
+## License
+
+[MIT](LICENSE)

volas-0.0.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["maturin>=1.4,<2.0"]
+build-backend = "maturin"
+
+[project]
+name = 'volas'
+dynamic = ["version"]
+description = 'High-performance, Rust-backed columnar kernel for stock / candlestick (OHLCV) time-series data.'
+readme = 'README.md'
+authors = [
+  { name = 'Kael Zhang', email = 'i+pypi@kael.me' }
+]
+license = 'MIT'
+license-files = ['LICENSE']
+requires-python = '>=3.11'
+dependencies = [
+  "numpy>=2.0.0"
+]
+classifiers = [
+    'Programming Language :: Python',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+    'Programming Language :: Rust',
+    'Programming Language :: Python :: Implementation :: CPython',
+    'Natural Language :: English',
+    'Intended Audience :: Developers',
+    'Intended Audience :: Financial and Insurance Industry',
+    'Operating System :: OS Independent',
+    'Development Status :: 1 - Planning',
+    'Topic :: Office/Business :: Financial :: Investment'
+]
+
+[project.urls]
+Homepage = "https://github.com/kaelzhang/volas"
+
+[project.optional-dependencies]
+dev = [
+  "coverage",
+  "ruff",
+  "pytest",
+  "pytest-cov",
+  "pytest-benchmark",
+  "twine",
+  # PEP 639 / Metadata 2.4 license fields require packaging >= 24.2 to publish
+  "packaging>=24.2",
+  "numpy>=2.0.0",
+  "mypy",
+  "maturin>=1.4"
+]
+
+[tool.maturin]
+# The Rust crate builds the `volas_rs` extension module
+module-name = "volas_rs"
+binding = "pyo3"
+features = ["pyo3/extension-module"]
+# Pure-Python package to include alongside the compiled module
+python-packages = ["volas"]
+
+[tool.mypy]
+warn_return_any = true
+ignore_missing_imports = true
+no_implicit_optional = true
+strict_optional = true

volas-0.0.0/src/lib.rs

@@ -0,0 +1,13 @@
+//! volas-rs: high-performance Rust core for the `volas` time-series kernel.
+//!
+//! This crate is the compiled backend for the `volas` Python package.
+//! It is currently an empty scaffold; storage and indicator logic will live
+//! here.
+
+use pyo3::prelude::*;
+
+/// The Rust extension module backing the `volas` package.
+#[pymodule]
+fn volas_rs(_m: &Bound<'_, PyModule>) -> PyResult<()> {
+    Ok(())
+}

volas-0.0.0/volas/__init__.py

@@ -0,0 +1,7 @@
+"""volas - a high-performance, Rust-backed columnar kernel for stock /
+candlestick (OHLCV) time-series data.
+"""
+
+from importlib.metadata import version as _get_version
+
+__version__ = _get_version('volas')