pyproject.toml

[build-system]
requires = ["setuptools>=65.5.0", "setuptools_scm[toml]>=6.4.0"]
build-backend = "setuptools.build_meta"

[project]
name = "flow.record"
description = "A library for defining and creating structured data (called records) that can be streamed to disk or piped to other tools that use flow.record"
readme = "README.md"
requires-python = "~=3.9"
license.text = "Affero General Public License v3"
authors = [
  {name = "Dissect Team", email = "dissect@fox-it.com"}
]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Intended Audience :: Developers",
  "Intended Audience :: Information Technology",
  "License :: OSI Approved",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3",
  "Topic :: Scientific/Engineering :: Information Analysis",
  "Topic :: Utilities",
]
dependencies = [
    "msgpack>=0.5.2",
    "tzdata; platform_system=='Windows'",
]
dynamic = ["version"]

[project.urls]
homepage = "https://dissect.tools"
documentation = "https://docs.dissect.tools/en/latest/projects/flow.record"
repository = "https://github.com/fox-it/flow.record"

[project.optional-dependencies]
# Note: these compression libraries do not work well with pypy
compression = [
    "lz4",
    "zstandard",
]
elastic = [
    "elasticsearch",
]
geoip = [
    "maxminddb",
]
avro = [
    "cramjam<2.8.4; platform_python_implementation == 'PyPy' and python_version == '3.9'",
    "fastavro[snappy]",
]
duckdb = [
    "duckdb",
    "pytz", # duckdb requires pytz for timezone support
]
splunk = [
    "httpx",
]
test = [
    "flow.record[compression]",
    "flow.record[avro]",
    "flow.record[elastic]",
    "duckdb; platform_python_implementation != 'PyPy' and python_version < '3.12'", # duckdb
    "pytz; platform_python_implementation != 'PyPy' and python_version < '3.12'", # duckdb
    "tqdm",
]
full = [
    "flow.record[compression]",
    "tqdm",
]

[project.scripts]
rdump = "flow.record.tools.rdump:main"
rgeoip = "flow.record.tools.geoip:main"

[tool.ruff]
line-length = 120
required-version = ">=0.9.0"
extend-exclude = ["flow/record/version.py"]

[tool.ruff.format]
docstring-code-format = true

[tool.ruff.lint]
select = [
  "F",
  "E",
  "W",
  "I",
  "UP",
  "YTT",
  "ANN",
  "B",
  "C4",
  "DTZ",
  "T10",
  "FA",
  "ISC",
  "G",
  "INP",
  "PIE",
  "PYI",
  "PT",
  "Q",
  "RSE",
  "RET",
  "SLOT",
  "SIM",
  "TID",
  "TCH",
  "PTH",
  "PLC",
  "TRY",
  "FLY",
  "PERF",
  "FURB",
  "RUF",
]
ignore = ["E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003"]

[tool.ruff.lint.per-file-ignores]
"tests/docs/**" = ["INP001"]

[tool.ruff.lint.isort]
known-first-party = ["flow.record"]

[tool.setuptools]
license-files = ["LICENSE", "COPYRIGHT"]

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

[tool.setuptools_scm]
version_file = "flow/record/version.py"