pyproject.toml

[build-system]
# >=77 for PEP 639: the SPDX `license` string and `license-files` below.
requires = ["setuptools>=77", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "replicant"
version = "0.10.0"
description = "Safe, synthetic firewall CEF telemetry (FortiGate, Palo Alto PAN-OS, Check Point) for detection engineering."
readme = "README.md"
requires-python = ">=3.11"
# PEP 639 SPDX expression. The old `{ text = ... }` table is deprecated and
# setuptools stops accepting it on 2027-02-18.
license = "Apache-2.0"
license-files = ["LICENSE", "NOTICE"]
authors = [{ name = "Imran Hafeez (RZA)" }]
keywords = ["cef", "syslog", "fortigate", "paloalto", "checkpoint", "detection-engineering", "mitre-attack", "logrhythm"]
classifiers = [
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Security",
]
dependencies = [
    "rich>=13",
    "pydantic>=2",
    "PyYAML>=6",
    "numpy>=1.26",
]

[project.optional-dependencies]
web = [
    "fastapi>=0.110",
    "uvicorn[standard]>=0.29",
]
dev = [
    "pytest>=8",
    "black>=24",
    "ruff>=0.5",
    "mypy>=1.10",
    "types-PyYAML",
    "httpx>=0.27",
    "fastapi>=0.110",
    "uvicorn[standard]>=0.29",
]

[project.scripts]
replicant = "replicant.cli.app:main"

[tool.setuptools.packages.find]
include = ["replicant*"]

[tool.setuptools.package-data]
# Everything the tool needs at run time must be inside the package, or a wheel
# installs a binary that reports its version and then cannot do anything. The
# catalogs used to sit in a top-level data/ directory reached by a repository
# path, so `pip install` produced exactly that.
#
# webui_dist is written by `npm run build` (see webui/vite.config.ts). It is a
# build artifact, so it is gitignored and simply absent when the frontend has not
# been built; the server serves a page explaining how to build it. Build the
# frontend BEFORE building a wheel if you want the UI in it.
replicant = [
    "py.typed",
    "data/*.yaml",
    "webui_dist/*",
    "webui_dist/assets/*",
    "webui_dist/fonts/*",
]

[tool.black]
line-length = 100
target-version = ["py311"]

[tool.ruff]
line-length = 100
target-version = "py311"

[tool.ruff.lint]
select = ["E", "F", "I", "W", "UP", "B"]
ignore = []

[tool.mypy]
python_version = "3.11"
strict = true
warn_unused_ignores = true
disallow_untyped_defs = true
no_implicit_optional = true
plugins = ["pydantic.mypy"]

[[tool.mypy.overrides]]
# numpy 2.x ships PEP 695 stubs that don't parse under the 3.11 target; treat the
# package as untyped (the engine casts all numpy returns to plain Python types).
module = ["numpy", "numpy.*"]
follow_imports = "skip"
follow_imports_for_stubs = true
ignore_missing_imports = true

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-q"