How To Read An Editorial Article

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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
[build-system]
requires = [
 "hatchling==1.32.0"
]
build-backend = "hatchling.build"

[project]
name = "socketsecurity"
version = "2.7.2"
requires-python = ">= 3.11"
license = {"file" = "LICENSE"}
dependencies = [
 "requests==2.34.2",
 "mdutils==1.8.1",
 "prettytable==3.18.0",
 "GitPython==3.1.59",
 "packaging==26.3",
 "python-dotenv==1.2.3",
 "socketdev==3.5.0",
 "beautifulsoup4==4.15.0",
 "markdown==3.10.3",
 "brotli==1.2.0; platform_python_implementation == 'CPython'",
 "brotlicffi==1.2.0.2; platform_python_implementation != 'CPython'",
]
readme = "README.md"
description = "Socket Security CLI for CI/CD"
keywords = ["socketsecurity", "socket.dev", "sca", "oss", "security"]
authors = [
 {name = "Douglas Coburn", email = "douglas@socket.dev"}
]
maintainers = [
 {name = "Douglas Coburn", email = "douglas@socket.dev"}
]
classifiers = [
 "Development Status :: 4 - Beta",
 "Intended Audience :: Developers",
 "Programming Language :: Python :: 3.11",
 "Programming Language :: Python :: 3.12",
]

[project.optional-dependencies]
test = [
 "pytest==9.1.1",
 "pytest-cov==7.1.0",
 "pytest-mock==3.15.1",
 "pytest-asyncio==1.4.0",
 "pytest-watch==4.2.0"
]
dev = [
 "ruff==0.16.5",
 "twine==7.0.0", # for building
 "uv==0.12.8", # for dependency management
 "pre-commit==4.6.2",
 "hatch==1.18.0"
]

[project.scripts]
socketcli = "socketsecurity.socketcli:cli"
socketclidev = "socketsecurity.socketcli:cli"

[project.urls]
Homepage = "https://socket.dev"

[tool.coverage.run]
source = ["socketsecurity"]
branch = true
include = [
 "socketsecurity/**/*.py",
 "socketsecurity/**/__init__.py"
]

[tool.coverage.report]
exclude_lines = [
 "pragma: no cover",
 "def __repr__",
 "if __name__ == .__main__.:",
 "raise NotImplementedError",
 "if TYPE_CHECKING:",
]
show_missing = true
skip_empty = true

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
 ".bzr",
 ".direnv",
 ".eggs",
 ".git",
 ".git-rewrite",
 ".hg",
 ".ipynb_checkpoints",
 ".mypy_cache",
 ".nox",
 ".pants.d",
 ".pyenv",
 ".pytest_cache",
 ".pytype",
 ".ruff_cache",
 ".svn",
 ".tox",
 ".venv",
 ".vscode",
 "__pypackages__",
 "_build",
 "buck-out",
 "build",
 "dist",
 "node_modules",
 "site-packages",
 "venv",
]

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
select = [
 "E4", "E7", "E9", "F", # Current rules
 "I", # isort
 "F401", # Unused imports
 "F403", # Star imports
 "F405", # Star imports undefined
 "F821", # Undefined names
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

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

[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = false

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"

[tool.hatch.build.targets.wheel]
include = ["socketsecurity", "LICENSE"]

[dependency-groups]
dev = [
 "pre-commit>=4.3.0",
]