optimade-gateway/pyproject.toml at main · Materials-Consortia/optimade-gateway · 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
[build-system]
requires = ["flit_core >=3.4,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "optimade-gateway"
authors = [
    {name = "Casper Welzel Andersen", email = "casper@welzel.nu"},
]
description = "A gateway server to query multiple OPTIMADE databases."
readme = "README.md"
license = {file = "LICENSE"}
classifiers = [
    "Development Status :: 4 - Beta",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Intended Audience :: Developers",
    "Topic :: Database",
    "Topic :: Database :: Database Engines/Servers",
    "Topic :: Internet :: WWW/HTTP :: WSGI :: Server",
    "Topic :: Scientific/Engineering :: Chemistry",
    "Topic :: Scientific/Engineering :: Physics",
]
keywords = ["optimade", "materials", "database"]
requires-python = ">=3.10"
dynamic = ["version"]

dependencies = [
    "httpx>=0.24.1,<1",
    "motor~=3.4",
    "optimade[server]~=1.0",
]

[project.optional-dependencies]
docs = [
    "mike~=2.0",
    "mkdocs>=1.5.3,<1.7",
    "mkdocs-awesome-pages-plugin~=2.9",
    "mkdocs-material>=9.5.5,<10",
    "mkdocstrings[python]~=1.0.0",
]
dev = [
    "mongomock_motor~=0.0.29",
    "optimade-gateway[docs]",
    "pre-commit~=4.0",
    "pytest>=8.4,<10",
    "pytest-asyncio~=1.3.0",
    "pytest-cov~=7.0",
    "pytest-httpx~=0.36.0",
]

[project.urls]
Home = "https://github.com/Materials-Consortia/optimade-gateway"
Documentation = "https://www.optimade.org/optimade-gateway"
Source = "https://github.com/Materials-Consortia/optimade-gateway"
"Issue Tracker" = "https://github.com/Materials-Consortia/optimade-gateway/issues"
Changelog = "https://github.com/Materials-Consortia/optimade-gateway/blob/main/CHANGELOG.md"
# Package = "https://pypi.org/project/optimade-gateway"

[project.scripts]
optimade-gateway = "optimade_gateway.run:run"

# TOOLS
[tool.flit.module]
name = "optimade_gateway"

[tool.flit.sdist]
exclude = [
    ".ci/",
    ".github/",
    "tests/",
    ".gitignore",
    ".pre-commit-config.yaml",
    ".codecov.yml",
    "docker-compose.yml",
    "Dockerfile",
]
include = [
    "optimade_gateway/*.json",
]

[tool.mypy]
python_version = "3.10"
ignore_missing_imports = true
scripts_are_modules = true
warn_unused_configs = true
show_error_codes = true
allow_redefinition = true

[tool.pytest.ini_options]
minversion = "7.4"
addopts = "-rs --cov=./optimade_gateway/ --cov-report=term-missing:skip-covered --no-cov-on-fail"
filterwarnings = [
    # Treat all warnings as errors
    "error",

    # Ignore pydantic v2.11 deprecation warning for things in OPT
    "ignore:.*Accessing the 'model_fields' attribute on the instance is deprecated.*:pydantic.warnings.PydanticDeprecatedSince211",
]
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"

[tool.ruff.lint]
extend-select = [
    "E",  # pycodestyle
    "F",  # pyflakes
    "B",  # flake8-bugbear
    "I",  # isort
    "ARG",  # flake8-unused-arguments
    "C4",  # flake8-comprehensions
    "ICN",  # flake8-import-conventions
    "G",  # flake8-logging-format
    "PGH",  # pygrep-hooks
    "PIE",  # flake8-pie
    "PL",  # pylint
    "PT",  # flake8-pytest-style
    "PTH",  # flake8-use-pathlib
    "RET",  # flake8-return
    "RUF",  # Ruff-specific
    "SIM",  # flake8-simplify
    "T20",  # flake8-print
    "YTT",  # flake8-2020
    "EXE",  # flake8-executable
    "NPY",  # NumPy specific rules
    "PYI",  # flake8-pyi
]
ignore = [
    "PLC",  # Convention related pylint codes
    "PLR",  # Refactor related pylint codes
    "B028",  # Bugbear: No explicit 'stacklevel' keyword argument to 'warnings.warn' call
]
# isort.required-imports = ["from __future__ import annotations"]

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["T20"]
"optimade_gateway/run.py" = ["T20"]
"optimade_gateway/models/**" = ["B006"]
"optimade_gateway/queries/params.py" = ["B006"]