HPMCM/pyproject.toml at main · KIPAC/HPMCM · 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
[project]
name = "hpmcm"
requires-python = ">=3.10"
license = {file = "LICENSE"}
readme = "README.md"
authors = [
    { name = "Eric Charles", email = "badass@stanford.edu" }
]
description="=Matching algorithm for multiple input source catalogs"
classifiers = [
    "Development Status :: 4 - Beta",
    "License :: OSI Approved :: MIT License",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
]
dynamic = ["version"]
dependencies = [
    "deprecated",
    "pyyaml",
    "numpy",
    "click",
    "astropy",
    "scipy",
    "matplotlib",
    "tables_io",
    "photutils",
    "pyarrow",
    "pandas",
]


# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
    "pytest",
    "pytest-cov", # Used to report total code coverage
    "pre-commit", # Used to run checks before finalizing a git commit
    "pylint", # Used for static linting of files
    "jupyter", # Used to render simple test notebook
    "mypy",   # typechecking
]
docs = [
    "nbsphinx",
    "sphinx", # Used to automatically generate documentation
    "sphinx-autodoc-typehints",
    "sphinx_rtd_theme", # Used to render documentation
    "sphinx-autoapi", # Used to automatically generate api documentation
    "sphinx-tabs", # Used to create tabbed content within the docs
    "sphinx-click", # Used for command line interface docs
]


[project.scripts]
hpmcm = "hpmcm.cli.commands:cli"

[build-system]
requires = [
    "setuptools>=62", # Used to build and package the Python project
    "setuptools_scm>=6.2", # Gets release version from git. Makes it available programmatically
]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "src/hpmcm/_version.py"

[tool.pytest.ini_options]
testpaths = [
    "tests",
]
addopts = [
    "--cov=hpmcm",
    "--cov-report=html"
]

[tool.pylint]
disable = [
    "abstract-method",
    "chained-comparison",
    "too-many-statements",
    "too-many-arguments",
    "too-many-instance-attributes",
    "too-many-positional-arguments",
    "missing-module-docstring",
    "too-few-public-methods",
    "duplicate-code",
    "use-dict-literal",
    "broad-exception-caught",
]

function-naming-style = "camelCase"
method-naming-style = "camelCase"
variable-naming-style = "snake_case"
argument-naming-style = "snake_case"
class-naming-style = "PascalCase"
attr-naming-style = "snake_case"

max-line-length = 120
max-locals = 50
max-branches = 25
max-public-methods = 50

[tool.mypy]
disallow_untyped_defs = true
disallow_incomplete_defs = true
ignore_missing_imports = true
local_partial_types = true
no_implicit_reexport = true
show_error_codes = true
strict_equality = true
warn_redundant_casts = true
warn_unreachable = true
warn_unused_ignores = true

[tool.pylint.MASTER]
ignore-paths = [
    "src/hpmcm/_version.py",
]

[tool.coverage.run]
omit = [
     "*/_version.py",
     ]

[tool.coverage.report]
exclude_also = [
    "raise NotImplementedError",
    "__repr__",
    "TYPE_CHECKING",
    "if cls._instance is None:",
    "except KeyError as missing_key:",
]