pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

# The repo root is the kernel. `src/nu` is this distribution and nothing else;
# the rest of the stack sits in `pkgs/`, one directory per distribution:
#
#   src/nu           -> nucore   (the kernel)        import nu
#   pkgs/nustd       -> nustd    (the fabrics)       import nustd
#   pkgs/nucli       -> nucli    (the `nu` command)  import nucli
#   pkgs/nudle       -> nudle    (the compiled SPA)  import nudle
#   pkgs/ts/ui-core  -> @nustackdev/ui-core
#   pkgs/ts/ui-kit   -> @nustackdev/ui-kit
#   pkgs/ts/nudle    -> the vite app; its dist/ is what the nudle wheel ships
#
# One distribution, one import name, one tree each. Nothing reaches into
# anyone else's package directory, except the nudle wheel reaching for the
# vite output that is its entire payload.
[project]
name = "nucore"
version = "0.5.2"
description = "The interaction primitive. Build apps in one primitive that spans your whole stack (databases, UIs, AI agents, and services). No glue. 50x less code."
readme = "README.md"
license = "Apache-2.0"
authors = [{ name = "Gor Arakelyan", email = "gorarkln@gmail.com" }]
requires-python = ">=3.10"
# The kernel: language, engine, core/flows/spans/forms, tree, prog, info,
# inspect. No fabric backend ever lands here -- those live in the `nustd`
# distribution and merge into the same `nu.` namespace. The `nu` command lives
# in `nucli`.
dependencies = [
    "typing-extensions>=4.7.0",
    "cloudpickle>=3.0",
]
keywords = [
    "nu",
    "nustack",
    "python",
    "state-management",
    "distributed-systems",
    "ai-agents",
    "agentic",
    "ray",
    "llm",
    "database",
    "key-value-store",
    "rocksdb",
    "ui",
    "real-time",
    "observability",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "License :: OSI Approved :: Apache Software License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
]

# No extras here on purpose. Fabric backends live on `nustd`'s extras and the
# `nu` command lives in `nucli`; the kernel never reaches up into its own
# dependents. Install everything with `pip install "nustd[all]" nucli`.

[project.urls]
Repository = "https://github.com/nustackdev/nu"

[tool.hatch.build.targets.wheel]
packages = ["src/nu"]

# The project root is the repo root, so the sdist default (everything not
# gitignored) would swallow `pkgs/`, `tests/` and `examples/` into the kernel
# tarball. Name what belongs to this distribution and nothing else.
[tool.hatch.build.targets.sdist]
only-include = [
    "src/nu",
    "README.md",
    "LICENSE.md",
]

# =============================================================================
# Workspace
# =============================================================================
# Dev-time wiring only. `[tool.uv.workspace]` and `[tool.uv.sources]` never
# reach published metadata, so every member stays a self-sufficient
# distribution with its own pyproject, version and dependencies. What the
# workspace buys: `uv sync` installs all four editable against each other
# instead of pulling the kernel from PyPI, and `uv build --package <name>`
# (what the Makefile and CI release on) works from the root.
#
# `pkgs/ts` is the npm workspace and holds no pyproject, so the members are
# listed rather than globbed.
[tool.uv.workspace]
members = ["pkgs/nustd", "pkgs/nucli", "pkgs/nudle"]

[tool.uv.sources]
# The root project is a member too: without this entry `nustd`'s `nucore`
# dependency resolves from PyPI instead of `src/nu`, and you end up testing
# the published kernel while editing the local one.
nucore = { workspace = true }
nustd = { workspace = true }
nucli = { workspace = true }
nudle = { workspace = true }

[tool.uv]
default-groups = ["dev"]

[dependency-groups]
dev = [
    # The root project (nucore) installs itself; these are the rest of the
    # workspace, editable, with every fabric backend -- so a bare `uv sync`
    # gives you the full dev environment and the whole suite.
    "nustd[all]",
    "nucli",
    "ruff>=0.8.0",
    "pre-commit>=3.0.0",
    "pytest>=7.0.0",
    "pytest-cov>=4.0.0",
    "pytest-xdist>=3.0.0",
    "pytest-timeout>=2.1.0",
    "pytest-benchmark>=4.0.0",
    "hypothesis>=6.0.0",
    "pytest-asyncio>=1.3.0",
    # The narrowing suite is a mypy suite -- without this it skips itself and
    # static-narrowing regressions land unnoticed.
    "mypy>=1.0",
]

# =============================================================================
# Shared tooling -- covers every package in the repo, not just the kernel
# =============================================================================

# Tests stay at the repo root: one suite over the whole stack.
[tool.pytest.ini_options]
testpaths = [
    "tests",
]
# `tests/_lib` is the only directory on sys.path, and `_support` is the only
# thing in it -- so no test directory can ever shadow a real package name.
# The underscore also keeps pytest from collecting it as tests.
pythonpath = [
    "tests/_lib",
]
python_files = ["test_*.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = ["-ra", "--strict-markers", "--strict-config", "--import-mode=importlib"]
asyncio_mode = "auto"
xfail_strict = true
markers = [
    "slow: marks tests as slow",
    "integration: marks tests as integration tests",
    "inmemory: storage-backend parametrization — in-memory tkv",
    "rocksdb: storage-backend parametrization — rocksdb tkv",
    "lmdb: storage-backend parametrization — lmdb tkv",
    "text: storage-backend parametrization — text/debug tkv",
]

[tool.coverage.run]
source = [
    "src",
    "pkgs/nustd/src",
    "pkgs/nucli/src",
]
omit = ["*/tests/*", "*/__pycache__/*"]
branch = true
parallel = true

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "def __str__",
    "raise AssertionError",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
    "if typing.TYPE_CHECKING:",
    "@abstractmethod",
    "@abc.abstractmethod",
]
precision = 2
show_missing = true
skip_covered = true

[tool.coverage.html]
directory = "reports/coverage"

[tool.ruff]
line-length = 100
target-version = "py310"
src = [
    "src",
    "pkgs/nustd/src",
    "pkgs/nucli/src",
    "pkgs/nudle/src",
]
extend-exclude = [".venv", "build", "dist", "*.egg-info", "node_modules"]

[tool.ruff.lint]
select = [
    "E",      # pycodestyle errors
    "W",      # pycodestyle warnings
    "F",      # pyflakes
    "I",      # isort
    "B",      # flake8-bugbear
    "C4",     # flake8-comprehensions
    "UP",     # pyupgrade
    "N",      # pep8-naming
    "YTT",    # flake8-2020
    "S",      # flake8-bandit (security)
    "T20",    # flake8-print
    "D",      # pydocstyle
    "ANN",    # flake8-annotations
    "TC",     # flake8-type-checking
    "RUF",    # ruff-specific rules
    "PTH",    # flake8-pathlib
]
ignore = [
    "E501",   # handled by formatter
    "D105",   # docstring in magic method
    "D107",   # docstring in __init__ (covered by class docstring)
]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint.per-file-ignores]
"**/tests/**/*.py" = [
    "S101", "S108", "T20", "D", "E711", "E712", "ANN", "N806",
]
"**/testing/**/*.py" = [
    "S101", "T20", "D", "E711", "E712", "ANN", "N806", "B017",
]
"examples/**/*.py" = [
    "S101", "T20", "D", "ANN",
]
# The demos the `nu` command ships are examples that happen to live in a
# package, so they get the same rules as examples/.
"**/src/nucli/demos/**/*.py" = [
    "S101", "T20", "D", "ANN",
]
"benchmarks/**/*.py" = [
    "S101", "T20", "D", "ANN", "B007",
]
"**/ops/control/**/*.py" = [
    "ANN401",  # Any needed for polymorphic control op parameters
]
"**/refs/std.py" = [
    "N811", "N812",  # std Forms (UUID, date, ...) aliased as *Form to not shadow stdlib types
]
"**/src/nustd/ui/core/**/*.py" = [
    "D102", "D103",
    "ANN401",  # _acompile athunks legitimately return Any (host-lifted primitive)
]
"**/src/nustd/ui/refs/**/*.py" = [
    "D102",    # widget setters are one-liners; docstring per method is ceremony
    "ANN401",
]
"**/src/nustd/ui/nudle/**/*.py" = [
    "D102", "D103", "D205", "ANN401", "S110",
]
"**/src/nustd/ws_server/**/*.py" = [
    "D102", "D103", "D205", "ANN401", "S110",
]
"**/src/nustd/http/methods.py" = [
    "N802",  # GET/POST/PUT/PATCH/DELETE mirror HTTP verbs
]

[tool.ruff.lint.isort]
known-first-party = [
    "nu", "nustd", "nucli",
    "virtuals", "invisibles",
    ]
force-single-line = false
lines-after-imports = 2

[tool.ruff.format]
quote-style = "double"
indent-style = "space"

[tool.mypy]
python_version = "3.10"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = false
ignore_missing_imports = true
exclude = [
    "build/",
    "dist/",
    ".venv/",
    "node_modules/",
]

[tool.bandit]
exclude_dirs = ["examples/"]