datashuttle/pyproject.toml at 943350c9a67b93cfbfcadad809ce85903dfe384b · neuroinformatics-unit/datashuttle · 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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
[project]
name = "datashuttle"
authors = [
    {name = "Joe Ziminski", email = "j.ziminski@ucl.ac.uk"},
    {name = "Adam Tyson", email = "code@adamltyson.com"},
    {name = "Niko Sirmpilatze", email = "niko.sirbiladze@gmail.com"},
]
description = "DataShuttle automates the creation, validation and transfer of neuroscience project folders."
readme = "README.md"
requires-python = ">=3.9.0"
dynamic = ["version"]
license = {text = "BSD-3-Clause"}

dependencies = [
    "paramiko",
    "PyYAML",
    "requests",
    "rich",
    "simplejson",
    "pyperclip",
    "textual>=3.4.0",
    "show-in-file-manager",
    "gitpython",
    "typeguard",
    "psutil",
    # Skip the fancylog versions which logs env packages
    # by default, which is slow due to subprocess calls.
    "fancylog >=0.4.2,!=0.5.*,!=0.6.*"
]

classifiers = [
    "Development Status :: 4 - Beta",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Operating System :: OS Independent",
    "License :: OSI Approved :: BSD License",
]

[project.urls]
"Bug Tracker" = "https://github.com/neuroinformatics-unit/datashuttle/issues"
Documentation = "https://datashuttle.neuroinformatics.dev"
"Source Code" = "https://github.com/neuroinformatics-unit/datashuttle"
"User support" = "https://github.com/neuroinformatics-unit/datashuttle/discussions"

[project.optional-dependencies]
dev = [
    "pandas",
    "pytest",
    "pytest-cov",
    "pytest-mock",
    "coverage",
    "tox",
    "mypy",
    "pre-commit",
    "ruff",
    "setuptools_scm",
    "textual-dev",
    "types-requests",
    "types-PyYAML",
    "types-appdirs",
    "types-paramiko",
    "types-simplejson",
    "pandas-stubs",
    "types-setuptools",
    "pytest-asyncio",
    "validators",
    "filelock",
    "python-dotenv",
]

[build-system]
requires = [
    "setuptools>=45",
    "wheel",
    "setuptools_scm[toml]>=6.2",
]
build-backend = "setuptools.build_meta"

[[tool.mypy.overrides]]
module = "tests.*"
ignore_errors = true

[tool.setuptools]
include-package-data = true

[tool.setuptools.packages.find]
include = ["datashuttle*"]
exclude = ["tests*", "docs*"]

[tool.pytest.ini_options]
addopts = "--cov=datashuttle"

[tool.ruff]
line-length = 79
exclude = ["__init__.py","build",".eggs"]
fix = true

# Ruff config is not exactly the same as in the movement repo, as
# currently we are only adding linting enforcement to docstrings.
# Other ruff rules that are also present in movement repo can be
# added here in a separate PR after these changes have been merged.

[tool.ruff.lint]
# See https://docs.astral.sh/ruff/rules/

ignore = [
    "E203",  # whitespace before ':' (conflicts with Black)
    "E501",  # line too long (handled by Black)
    "E731",  # do not assign a lambda expression, use a def
    "C901",  # function is too complex
    "W291",  # trailing whitespace
    "W293",  # blank line contains whitespace
    "E402",  # module level import not at top of file
    "E722",  # do not use bare 'except'
    "D100",  # missing docstring in public module
    "D203",  # 1 blank line required before class docstring (conflicts with D211)
    "D213",  # multi-line docstring summary should start at the second line (conflicts with D212)
]
select = [
    "I",        # isort
    "E",        # pycodestyle errors
    "F",        # Pyflakes
    "TC",       # flake8-type-checking
    "TID252",   # flake8-tidy-imports relative-imports
    "D",        # pydocstyle
]
per-file-ignores = { "tests/*" = [
    "D",  # ignore docstring formatting in tests for now
    "TID252"
], "examples/*" = [
    "D400", # first line should end with a period.
    "D415", # first line should end with a period, question mark...
    "D205", # missing blank line between summary and description
]}

[tool.ruff.format]
docstring-code-format = true # Also format code in docstrings

[tool.ruff.lint.mccabe]
max-complexity = 18

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.setuptools_scm]

[tool.check-manifest]
ignore = [
  "*.yaml",
  ".bumpversion.cfg",
  "tox.ini",
  "docs/*",
  "docs/source/*",
  "docs/source/pages/*",
  "tests/*",
  "tests/tests_unit/*",
  "tests/tests_integration/*",
  ".flake8"
]

[project.scripts]
datashuttle = "datashuttle.tui_launcher:main"

[tool.codespell]
skip = '.git,*.pdf,*.svg,*.yml'
#
# ignore-words-list = ''