acquire/pyproject.toml at main · fox-it/acquire · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
[build-system]
requires = ["setuptools>=77.0.0", "setuptools_scm[toml]>=6.4.0"]
build-backend = "setuptools.build_meta"

[project]
name = "acquire"
description = "A tool to quickly gather forensic artifacts from disk images or a live system into a lightweight container"
readme = "README.md"
requires-python = ">=3.10"
license = "AGPL-3.0-or-later"
license-files = ["LICENSE", "COPYRIGHT"]
authors = [
  {name = "Dissect Team", email = "dissect@fox-it.com"}
]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Intended Audience :: Developers",
  "Intended Audience :: Information Technology",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3",
  "Topic :: Internet :: Log Analysis",
  "Topic :: Scientific/Engineering :: Information Analysis",
  "Topic :: Security",
  "Topic :: Utilities",
]
dependencies = [
    "dissect.cstruct>=4,<5",
    "dissect.target>=3.25,<4",
]
dynamic = ["version"]

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

[project.optional-dependencies]
full = [
    "minio",
    "pycryptodome",
    "requests",
    "rich",
    "dissect.target[full]>=3.23,<4",
    "requests_toolbelt",
]
dev = [
    "acquire[full]",
    "dissect.cstruct>=4.0.dev,<5.0.dev",
    "dissect.target[dev]>=3.25,<4.0.dev",
]

[dependency-groups]
test = [
    "pytest",
]
lint = [
    "ruff==0.13.1",
    "vermin",
]
build = [
    "build",
]
debug = [
    "ipdb",
]
dev = [
    {include-group = "test"},
    {include-group = "lint"},
    {include-group = "debug"},
]

[project.scripts]
acquire = "acquire.acquire:main"
acquire-decrypt = "acquire.tools.decrypter:main"

[tool.ruff]
line-length = 120
required-version = ">=0.13.1"

# Exclude setuptools_scm autogenerated file from linting
extend-exclude = ["acquire/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",
  "TC",
  "PTH",
  "PLC",
  "TRY",
  "FLY",
  "PERF",
  "FURB",
  "RUF",
  "D"
]
ignore = [
    "E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003",
    # Ignore some pydocstyle rules for now as they require a larger cleanup
    "D1",
    "D205",
    "D301",
    "D417",
    # Seems bugged: https://github.com/astral-sh/ruff/issues/16824
    "D402",
]
future-annotations = true

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

[tool.ruff.lint.flake8-type-checking]
strict = true

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

[tool.ruff.lint.isort]
known-first-party = ["acquire"]
required-imports = ["from __future__ import annotations"]

[tool.setuptools.packages.find]
include = ["acquire", "acquire.*"]

[tool.setuptools_scm]
write_to = "acquire/version.py"