gridcalc 0.1.1__tar.gz

gridcalc-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shakeeb Alireza
+
+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.

gridcalc-0.1.1/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: gridcalc
+Version: 0.1.1
+Summary: A terminal spreadsheet powered by Python formulas
+Keywords: spreadsheet,terminal,tui,curses,calculator,visicalc
+Author: Shakeeb Alireza
+Author-email: Shakeeb Alireza <shakfu@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console :: Curses
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Dist: tomli>=1.0 ; python_full_version < '3.11'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/shakfu/gridcalc
+Project-URL: Repository, https://github.com/shakfu/gridcalc
+Project-URL: Issues, https://github.com/shakfu/gridcalc/issues
+Description-Content-Type: text/markdown
+
+# gridcalc
+
+[![PyPI](https://img.shields.io/pypi/v/gridcalc)](https://pypi.org/project/gridcalc/)
+[![Python](https://img.shields.io/pypi/pyversions/gridcalc)](https://pypi.org/project/gridcalc/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+A terminal spreadsheet powered by Python formulas. Based on Serge Zaitsev's [kalk](https://github.com/zserge/kalk), reimplemented in pure Python from [pktcalc](https://github.com/sa/pktcalc).
+
+Uses Python's `eval()` for formula evaluation. Reads and writes JSON. File-compatible with pktcalc.
+
+```sh
+$ gridcalc budget.json
+```
+
+## Install
+
+From PyPI (requires Python 3.10+):
+
+```sh
+pip install gridcalc
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install gridcalc
+```
+
+Then run:
+
+```sh
+gridcalc                     # new spreadsheet
+gridcalc budget.json         # open a file
+```
+
+### From source
+
+```sh
+git clone https://github.com/shakfu/gridcalc.git
+cd gridcalc
+uv run gridcalc
+```
+
+## File format
+
+Spreadsheets are stored as JSON:
+
+```json
+{
+  "code": "def margin(rev, cost):\n    return (rev - cost) / rev * 100\n",
+  "names": {
+    "revenue": "A1:A12",
+    "costs": "B1:B12"
+  },
+  "cells": [
+    ["Revenue", "Cost", "Margin"],
+    [1000, 600, "=margin(A1, B1)"],
+    [1200, 700, "=margin(A2, B2)"]
+  ],
+  "format": {
+    "width": 10
+  }
+}
+```
+
+- **cells**: 2D array of cell values (numbers, strings, formulas, or null)
+- **code** (optional): Python code executed before formulas (functions, imports, constants)
+- **names** (optional): named ranges mapping names to cell ranges
+- **format** (optional): display settings (currently only `width`)
+
+## Usage
+
+Arrow keys navigate. Type a number or `=` to enter data. Formulas start
+with `=` and are Python expressions. Anything else is a label.
+
+Press `:` for the command line (vim-style):
+
+	:q              Quit
+	:q!             Force quit (no save prompt)
+	:w [file]       Save
+	:wq [file]      Save and quit
+	:e              Edit code block in $EDITOR
+	:o [file]       Open file
+	:b              Blank current cell
+	:clear          Clear entire sheet
+	:f <fmt>        Format/style cell (b u i L R I G D $ % * or Python spec)
+	:gf <fmt>       Set global format
+	:width <n>      Set column width (4-40)
+	:dr             Delete row
+	:dc             Delete column
+	:ir             Insert row
+	:ic             Insert column
+	:m              Move row/column (arrow keys to drag)
+	:r              Replicate (copy with relative refs)
+	:name <n> [range]  Define named range
+	:names          List named ranges
+	:unname <n>     Remove named range
+	:tv/:th/:tb/:tn Lock/unlock title rows/columns
+
+Other keys:
+
+	>           Go to cell (type reference)
+	!           Force recalculation
+	"           Enter label
+	Backspace   Clear cell
+	Tab         Next column
+	Enter       Next row
+	Home        Jump to A1
+	Ctrl-B      Toggle bold
+	Ctrl-U      Toggle underline
+	Ctrl-Z      Undo
+	Ctrl-Y      Redo
+	Ctrl-C      Quit
+
+## Formulas
+
+Formulas are Python expressions prefixed with `=`. Cell references like
+`A1`, `B3`, `AA10` are available as variables.
+
+	=A1 + B1 * 2
+	=(A1 + A2) / 2
+	=A1 ** 2
+	=SQRT(A3 + A2)
+
+### Range syntax
+
+Use `:` to reference a range of cells. Ranges expand into arrays (Vec)
+that support element-wise arithmetic.
+
+	=SUM(A1:A10)
+	=AVG(B1:B3)
+	=SUM(A1:A3 * B1:B3)
+
+### Named ranges
+
+Define a name for a cell range with `:name`, or in the JSON file's
+`names` field. Names are injected as arrays and can be used directly in
+formulas.
+
+	=SUM(revenue)
+	=SUM(revenue - costs)
+	=MAX(revenue)
+	=sum([x**2 for x in revenue])
+
+### Custom functions
+
+Use `:e` to open the code block in `$EDITOR`. The editor must block
+until the file is closed (e.g., `vim`, `nano`, or `subl -w` for Sublime
+Text). Define Python functions, import modules, set constants:
+
+```python
+import statistics
+
+def margin(rev, cost):
+    return (rev - cost) / rev * 100
+
+def compound(principal, rate, years):
+    return principal * (1 + rate) ** years
+
+TAX_RATE = 0.21
+```
+
+Then use them in formulas: `=margin(A1, B1)`, `=compound(1000, 0.05, 10)`.
+
+### Built-in functions
+
+	SUM(x)    Sum of array or scalar
+	AVG(x)    Average
+	MIN(x)    Minimum
+	MAX(x)    Maximum
+	COUNT(x)  Number of elements
+	ABS(x)    Absolute value (element-wise for arrays)
+	SQRT(x)   Square root (element-wise for arrays)
+	INT(x)    Truncate to integer (element-wise for arrays)
+
+Math functions are preloaded: `sin`, `cos`, `tan`, `exp`, `log`,
+`log2`, `log10`, `floor`, `ceil`, `pi`, `e`, `inf`. The `math` module
+is also available for anything else (`=math.factorial(10)`).
+
+Python builtins like `sum`, `min`, `max`, `abs`, `len` also work.
+
+### Arrays
+
+A formula can return an array. The cell displays the first element and
+the count, e.g. `3.0[12]`. The full array is shown in the status bar.
+Element-wise arithmetic works between arrays and scalars:
+
+	=revenue * 1.1
+	=revenue + costs
+
+### Cell references
+
+References adjust automatically on replicate, insert, and delete.
+Use `$` for absolute references: `$A$1` (fixed), `$A1` (fixed column),
+`A$1` (fixed row).
+
+## Formatting
+
+Use `:f` to set the display format or style of a cell. All formats
+and styles are persisted when saving.
+
+### Text styles
+
+Toggle with `:f` or keyboard shortcuts. Styles can be combined
+in a single command:
+
+	:f b            Toggle bold (also Ctrl-B)
+	:f u            Toggle underline (also Ctrl-U)
+	:f i            Toggle italic
+	:f bi           Toggle bold + italic
+	:f bui          Toggle bold + underline + italic
+
+### Number formats
+
+	:f $            Dollar (2 decimal places)
+	:f %            Percentage (value * 100, 2 decimal places)
+	:f I            Integer (truncate decimals)
+	:f *            Bar chart (asterisks proportional to value)
+	:f L            Left-align
+	:f R            Right-align
+	:f G            General (default)
+	:f D            Use global format
+
+Use `:gf` to set the global default format for all cells.
+
+### Python format specs
+
+For more control, pass any Python format specification:
+
+	:f ,.2f         1,234.50 (comma thousands, 2 decimals)
+	:f ,.0f         1,234,567 (comma thousands, no decimals)
+	:f .1%          15.7% (percentage with 1 decimal)
+	:f .4f          3.1416 (fixed 4 decimal places)
+	:f .2e          1.23e+04 (scientific notation)
+
+These use Python's `format()` builtin. Any valid
+[format spec](https://docs.python.org/3/library/string.html#format-specification-mini-language)
+works.
+
+## Development
+
+```sh
+make test       # run tests
+make lint       # ruff check
+make format     # ruff format
+make typecheck  # mypy
+make qa         # lint + typecheck + test + format
+```
+
+### Publishing
+
+```sh
+make check        # build and check dist with twine
+make publish-test # upload to TestPyPI
+make publish      # upload to PyPI
+```
+
+## License
+
+MIT

gridcalc-0.1.1/README.md

@@ -0,0 +1,260 @@
+# gridcalc
+
+[![PyPI](https://img.shields.io/pypi/v/gridcalc)](https://pypi.org/project/gridcalc/)
+[![Python](https://img.shields.io/pypi/pyversions/gridcalc)](https://pypi.org/project/gridcalc/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+A terminal spreadsheet powered by Python formulas. Based on Serge Zaitsev's [kalk](https://github.com/zserge/kalk), reimplemented in pure Python from [pktcalc](https://github.com/sa/pktcalc).
+
+Uses Python's `eval()` for formula evaluation. Reads and writes JSON. File-compatible with pktcalc.
+
+```sh
+$ gridcalc budget.json
+```
+
+## Install
+
+From PyPI (requires Python 3.10+):
+
+```sh
+pip install gridcalc
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install gridcalc
+```
+
+Then run:
+
+```sh
+gridcalc                     # new spreadsheet
+gridcalc budget.json         # open a file
+```
+
+### From source
+
+```sh
+git clone https://github.com/shakfu/gridcalc.git
+cd gridcalc
+uv run gridcalc
+```
+
+## File format
+
+Spreadsheets are stored as JSON:
+
+```json
+{
+  "code": "def margin(rev, cost):\n    return (rev - cost) / rev * 100\n",
+  "names": {
+    "revenue": "A1:A12",
+    "costs": "B1:B12"
+  },
+  "cells": [
+    ["Revenue", "Cost", "Margin"],
+    [1000, 600, "=margin(A1, B1)"],
+    [1200, 700, "=margin(A2, B2)"]
+  ],
+  "format": {
+    "width": 10
+  }
+}
+```
+
+- **cells**: 2D array of cell values (numbers, strings, formulas, or null)
+- **code** (optional): Python code executed before formulas (functions, imports, constants)
+- **names** (optional): named ranges mapping names to cell ranges
+- **format** (optional): display settings (currently only `width`)
+
+## Usage
+
+Arrow keys navigate. Type a number or `=` to enter data. Formulas start
+with `=` and are Python expressions. Anything else is a label.
+
+Press `:` for the command line (vim-style):
+
+	:q              Quit
+	:q!             Force quit (no save prompt)
+	:w [file]       Save
+	:wq [file]      Save and quit
+	:e              Edit code block in $EDITOR
+	:o [file]       Open file
+	:b              Blank current cell
+	:clear          Clear entire sheet
+	:f <fmt>        Format/style cell (b u i L R I G D $ % * or Python spec)
+	:gf <fmt>       Set global format
+	:width <n>      Set column width (4-40)
+	:dr             Delete row
+	:dc             Delete column
+	:ir             Insert row
+	:ic             Insert column
+	:m              Move row/column (arrow keys to drag)
+	:r              Replicate (copy with relative refs)
+	:name <n> [range]  Define named range
+	:names          List named ranges
+	:unname <n>     Remove named range
+	:tv/:th/:tb/:tn Lock/unlock title rows/columns
+
+Other keys:
+
+	>           Go to cell (type reference)
+	!           Force recalculation
+	"           Enter label
+	Backspace   Clear cell
+	Tab         Next column
+	Enter       Next row
+	Home        Jump to A1
+	Ctrl-B      Toggle bold
+	Ctrl-U      Toggle underline
+	Ctrl-Z      Undo
+	Ctrl-Y      Redo
+	Ctrl-C      Quit
+
+## Formulas
+
+Formulas are Python expressions prefixed with `=`. Cell references like
+`A1`, `B3`, `AA10` are available as variables.
+
+	=A1 + B1 * 2
+	=(A1 + A2) / 2
+	=A1 ** 2
+	=SQRT(A3 + A2)
+
+### Range syntax
+
+Use `:` to reference a range of cells. Ranges expand into arrays (Vec)
+that support element-wise arithmetic.
+
+	=SUM(A1:A10)
+	=AVG(B1:B3)
+	=SUM(A1:A3 * B1:B3)
+
+### Named ranges
+
+Define a name for a cell range with `:name`, or in the JSON file's
+`names` field. Names are injected as arrays and can be used directly in
+formulas.
+
+	=SUM(revenue)
+	=SUM(revenue - costs)
+	=MAX(revenue)
+	=sum([x**2 for x in revenue])
+
+### Custom functions
+
+Use `:e` to open the code block in `$EDITOR`. The editor must block
+until the file is closed (e.g., `vim`, `nano`, or `subl -w` for Sublime
+Text). Define Python functions, import modules, set constants:
+
+```python
+import statistics
+
+def margin(rev, cost):
+    return (rev - cost) / rev * 100
+
+def compound(principal, rate, years):
+    return principal * (1 + rate) ** years
+
+TAX_RATE = 0.21
+```
+
+Then use them in formulas: `=margin(A1, B1)`, `=compound(1000, 0.05, 10)`.
+
+### Built-in functions
+
+	SUM(x)    Sum of array or scalar
+	AVG(x)    Average
+	MIN(x)    Minimum
+	MAX(x)    Maximum
+	COUNT(x)  Number of elements
+	ABS(x)    Absolute value (element-wise for arrays)
+	SQRT(x)   Square root (element-wise for arrays)
+	INT(x)    Truncate to integer (element-wise for arrays)
+
+Math functions are preloaded: `sin`, `cos`, `tan`, `exp`, `log`,
+`log2`, `log10`, `floor`, `ceil`, `pi`, `e`, `inf`. The `math` module
+is also available for anything else (`=math.factorial(10)`).
+
+Python builtins like `sum`, `min`, `max`, `abs`, `len` also work.
+
+### Arrays
+
+A formula can return an array. The cell displays the first element and
+the count, e.g. `3.0[12]`. The full array is shown in the status bar.
+Element-wise arithmetic works between arrays and scalars:
+
+	=revenue * 1.1
+	=revenue + costs
+
+### Cell references
+
+References adjust automatically on replicate, insert, and delete.
+Use `$` for absolute references: `$A$1` (fixed), `$A1` (fixed column),
+`A$1` (fixed row).
+
+## Formatting
+
+Use `:f` to set the display format or style of a cell. All formats
+and styles are persisted when saving.
+
+### Text styles
+
+Toggle with `:f` or keyboard shortcuts. Styles can be combined
+in a single command:
+
+	:f b            Toggle bold (also Ctrl-B)
+	:f u            Toggle underline (also Ctrl-U)
+	:f i            Toggle italic
+	:f bi           Toggle bold + italic
+	:f bui          Toggle bold + underline + italic
+
+### Number formats
+
+	:f $            Dollar (2 decimal places)
+	:f %            Percentage (value * 100, 2 decimal places)
+	:f I            Integer (truncate decimals)
+	:f *            Bar chart (asterisks proportional to value)
+	:f L            Left-align
+	:f R            Right-align
+	:f G            General (default)
+	:f D            Use global format
+
+Use `:gf` to set the global default format for all cells.
+
+### Python format specs
+
+For more control, pass any Python format specification:
+
+	:f ,.2f         1,234.50 (comma thousands, 2 decimals)
+	:f ,.0f         1,234,567 (comma thousands, no decimals)
+	:f .1%          15.7% (percentage with 1 decimal)
+	:f .4f          3.1416 (fixed 4 decimal places)
+	:f .2e          1.23e+04 (scientific notation)
+
+These use Python's `format()` builtin. Any valid
+[format spec](https://docs.python.org/3/library/string.html#format-specification-mini-language)
+works.
+
+## Development
+
+```sh
+make test       # run tests
+make lint       # ruff check
+make format     # ruff format
+make typecheck  # mypy
+make qa         # lint + typecheck + test + format
+```
+
+### Publishing
+
+```sh
+make check        # build and check dist with twine
+make publish-test # upload to TestPyPI
+make publish      # upload to PyPI
+```
+
+## License
+
+MIT

gridcalc-0.1.1/pyproject.toml

@@ -0,0 +1,71 @@
+
+
+[project]
+name = "gridcalc"
+version = "0.1.1"
+description = "A terminal spreadsheet powered by Python formulas"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Shakeeb Alireza", email = "shakfu@users.noreply.github.com" }
+]
+keywords = ["spreadsheet", "terminal", "tui", "curses", "calculator", "visicalc"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console :: Curses",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial :: Spreadsheet",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+]
+dependencies = [
+    "tomli>=1.0; python_version < '3.11'",
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.19.1",
+    "pytest",
+    "ruff>=0.15.7",
+    "twine>=6.2.0",
+    "build>=1.0",
+]
+
+[project.scripts]
+gridcalc = "gridcalc.tui:main"
+
+[project.urls]
+Homepage = "https://github.com/shakfu/gridcalc"
+Repository = "https://github.com/shakfu/gridcalc"
+Issues = "https://github.com/shakfu/gridcalc/issues"
+
+[build-system]
+requires = ["uv_build>=0.11.2,<0.12"]
+build-backend = "uv_build"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "S"]
+ignore = ["S307", "S603", "S605", "S108", "S102", "S110"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["S101"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_configs = true

gridcalc-0.1.1/src/gridcalc/__init__.py

@@ -0,0 +1,3 @@
+"""gridcalc -- a terminal spreadsheet."""
+
+__version__ = "0.1.1"

gridcalc-0.1.1/src/gridcalc/__main__.py

@@ -0,0 +1,11 @@
+import os
+import sys
+
+# Support both `python -m gridcalc` (relative import) and direct execution
+if __package__:
+    from .tui import main
+else:
+    sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+    from gridcalc.tui import main
+
+main()