Metadata-Version: 2.4
Name: eggcalc
Version: 1.1.7
Summary: CLI calculator accepting natural language and unit conversion. Can be used as a CLI, python library, or MCP server for AI agents.
Author-email: David Bowman <dbowman91@proton.me>
License: MIT
Project-URL: Homepage, https://github.com/eggstack/eggcalc
Project-URL: Repository, https://github.com/eggstack/eggcalc
Project-URL: Bug Tracker, https://github.com/eggstack/eggcalc/issues
Project-URL: Changelog, https://github.com/eggstack/eggcalc/blob/main/CHANGELOG.md
Keywords: calculator,math,natural-language,cli,expression-evaluator,unit-converter,mathematical-parser,mcp,agent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=24.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: mkdocs>=1.5; extra == "dev"
Requires-Dist: mkdocs-material>=9.0; extra == "dev"
Requires-Dist: mkdocstrings[python]>=0.24; extra == "dev"
Requires-Dist: pre-commit>=3.0; extra == "dev"
Requires-Dist: build>=0.10; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.5; extra == "docs"
Requires-Dist: mkdocs-material>=9.0; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
Dynamic: license-file

# eggcalc

CLI calculator accepting natural language and unit conversion. Standard library only.

Install with `pip install eggcalc` and run it like `calc 2 meters plus 2ft`. It is spacing-tolerant and normalizes operator-adjacent spacing before parsing, including unit forms like `30 km / h in mph`, `5 in in cm`, and spaced unit products like `5 N m` or `5 m s`.

Written in pure Python with no external dependencies, it can be used as a CLI tool, a Python library, or an MCP server for AI agents.

## Features

- **Natural Language Input**: `"five plus three times two"` → `11`
- **Unit Conversions**: `"30m + 100ft"` → `60.48 m`
- **Complex Numbers**: `"sqrt(-1)"` → `1j`
- **Safe Evaluation**: AST-based parsing, no `eval()`, blocks dangerous operations
- **MCP Server**: deterministic text, JSON, validation, math, path, manifest, patch, and repo-audit tools for AI agents
- **Pure Python**: Standard library only, no dependencies

## Requirements

- **Python 3.11 or higher** (3.10 is no longer supported)
- **Operating systems:** Linux, macOS, Windows (tested in CI on all three)
- All tools and features are fully available on every supported runtime — no reduced capability set

### Migrating from Python 3.10

Python 3.10 reached end-of-life and eggcalc now requires Python 3.11+ for standard-library `tomllib` and `math.cbrt` support. Upgrade your Python before upgrading eggcalc:

```bash
# Ubuntu/Debian
sudo apt install python3.11

# macOS (Homebrew)
brew install python@3.11

# Windows
winget install Python.Python.3.11
```

## Installation

```bash
pip install eggcalc
```

Or from source:

```bash
git clone https://github.com/eggstack/eggcalc.git && cd eggcalc
pip install -e .
```

Or run directly without installing:

```bash
python -m eggcalc "five plus two"
```

## CLI Usage

```bash
calc "five plus two"                    # 7
calc "(twenty + five) * 3"              # 75
calc "30m + 100ft"                      # 60.48 m
calc "sin of 3.14159"                   # 2.653e-06
calc "5 times avogadro"                 # 3.011e+24
calc -e "5 + 3"                         # 8 (quiet mode)
calc -i                                 # Interactive REPL
calc --mcp                              # MCP server mode
```

### CLI Options

| Option | Description |
|--------|-------------|
| `-e`, `--expression` | Evaluate a single expression (quiet mode) |
| `-q`, `--quiet` | Suppress expression in output |
| `--json` | Output result as JSON |
| `-i`, `--interactive` | Start interactive REPL |
| `--mcp` | Run as MCP server |
| `--capabilities` | Show runtime capabilities as JSON and exit |

## Python API

```python
from eggcalc import evaluate_raw, evaluate

# Full pipeline (natural language, spaces, units)
result = evaluate_raw("five plus three")    # 8
result = evaluate_raw("30m + 100ft")        # 60.48 m

# Fast path (pre-normalized expressions only, ~17x faster)
result = evaluate("5+3")                     # 8
```

**Caret (`^`) semantics differ between the two paths:**
- `evaluate()` treats `^` as **bitwise XOR** (Python AST semantics).
- `evaluate_raw()` and CLI normalize `^` as **exponentiation** (rewritten to `**` before parsing). Use `xor`/`bitxor` word forms for bitwise XOR through the full pipeline.

See [docs/api.md](docs/api.md) for the full API reference including `EggCalcApp`, `evaluate_cached()`, `evaluate_async()`, `evaluate_with_timeout()`, custom constants/functions, and performance benchmarks.

## MCP Server

eggcalc runs as an MCP server exposing deterministic tools across 18 categories (math, text, json, validation, regex, list, path, identifier, shell, markdown, config, version, toml, cargo, unicode, manifest, patch, repo). All results are deterministic — same input always produces the same output.

**Protocol version:** Supports MCP protocol `2025-11-25` (latest stable) with backward compatibility for `2024-11-05`. Clients must complete the `initialize` handshake before calling tools — tool requests before initialization are rejected. See [docs/mcp.md](docs/mcp.md) for protocol details and lifecycle requirements.

```bash
calc --mcp
```

**Programmatic multi-instance usage:** Each `McpServer` instance owns its own `McpServerConfig`, `ToolRegistry`, `ToolExecutor`, evaluator, and session set. Multiple servers in one process are fully isolated. See [docs/mcp.md](docs/mcp.md#programmatic-multi-instance-usage) for embedding examples.

See [docs/tool_inventory.md](docs/tool_inventory.md) for the complete generated tool inventory. See [docs/mcp.md](docs/mcp.md) for protocol usage, configuration, profiles, schema detail, and selected tool examples.

### Runtime Capabilities

Query runtime capabilities (Python version, platform, feature detection, eggcalc version, supported protocol modes) from the CLI or Python API:

```bash
calc --capabilities          # JSON output
python -c "from eggcalc import detect_capabilities; print(detect_capabilities().to_json(indent=2))"
```

The MCP server's `initialize` response also includes a `runtime` key with capability information.

## Supported Operations

**Arithmetic**: `+`, `-`, `*`, `/`, `**` · **Bitwise**: `&`, `|`, `^`, `~`, `<<`, `>>` · **Bases**: `0x` hex, `0b` binary, `0o` octal · **Complex**: `3+4i`, `5j` · **Percentage**: `50%` = 0.5

**Functions**: trig (`sin`, `cos`, `tan`), hyperbolic, math (`sqrt`, `log`, `exp`), combinatorics (`perm`, `comb`, `gcd`, `lcm`), prime (`isprime`, `primefactors`), statistics (`mean`, `median`, `std`), random, memory registers, variables, and more. See [docs/functions.md](docs/functions.md).

**Units**: length, time, data, mass, volume, pressure, energy, power, force, voltage, current, angle, speed, area, frequency. Supports metric prefixes and imperial units. See [docs/units.md](docs/units.md).

**Number words**: zero through quintillion, fractions (half, quarter, thousandth, etc.).

**Constants**: `pi`, `e`, `tau`, `i`, `avogadro`, `c`, `planck`, `boltzmann`, `gas constant`, and more.

## Custom Configuration

Create `eggcalc_config.py` to add custom constants, functions, and units:

```python
CUSTOM_CONSTANTS = {"myconst": 42}
CUSTOM_FUNCTIONS = {"mysquare": lambda x, y: x**2 + y**2}
CUSTOM_UNITS = {"m": {"nm": 1e-9}}
CUSTOM_ALIASES = {"meter": "m", "meters": "m"}
```

## Development

```bash
.venv/bin/python -m pytest tests/ -v     # Run tests
ruff check eggcalc tests                  # Lint
black eggcalc tests                       # Format
mypy eggcalc --ignore-missing-imports     # Type check
mypy --strict tests/typing/consumer.py    # Strict consumer API check
make check                                # All checks (lint, format, typecheck, docs, test)
python build_single.py                    # Build single-file distribution
```

## Security

eggcalc uses AST-based parsing (no `eval()`) with built-in DoS protection:

| Limit | Default |
|-------|---------|
| `MAX_INPUT_LENGTH` | 10,000 characters |
| `MAX_NESTING_DEPTH` | 100 |
| `MAX_EXPONENT` | 10,000 |
| `MAX_FACTORIAL` | 1,000 |

The MCP server adds additional resource bounds: request/output byte limits, per-tool timeouts, bounded thread pools, and pre-bounded inputs for all 77 tools. See [docs/mcp.md](docs/mcp.md#resource-limits) and [docs/mcp_resource_limits.md](docs/mcp_resource_limits.md) for details.

`eggcalc_config.py` is Python code loaded from the current working directory — only run eggcalc in directories you trust. Library APIs do not load config by default; set `EGGCALC_LOAD_CONFIG=1` to enable. CLI loads config by default. Disable config loading with `EGGCALC_NO_CONFIG=1`.

## License

MIT License
