emdatabase/pyproject.toml at main · electronmicroscopy/emdatabase · 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
[project]
name = "em-database"
version = "0.5.0"
description = "A database for electron microscopy data using pooch to download and manage files."
readme = "README.md"
requires-python = ">=3.11"
license = "MIT"
license-files = ["LICENSE"]
authors = [
    { name = "Carter Francis", email = "cartsfrancis@gmail.com" },
]
dependencies = [
    "pooch",
    "py7zr",
    "pyyaml",
    "tqdm>=4.67.1",
]
keywords = [
    "electron microscopy",
    "database",
    "materials science",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Scientific/Engineering :: Image Processing",
]

[project.scripts]
emdatabase-new-dataset = "emdatabase.new_dataset:main"

[project.urls]
Homepage = "https://electronmicroscopy.github.io/emdatabase/"
Documentation = "https://electronmicroscopy.github.io/emdatabase/datasets.html"
Repository = "https://github.com/electronmicroscopy/emdatabase"
Issues = "https://github.com/electronmicroscopy/emdatabase/issues"

[project.optional-dependencies]
widget = ["anywidget>=0.9"]
tests = ["pytest", "pytest-cov", "hyperspy", "quantem", "anywidget>=0.9", "jsonschema"]
doc = ["sphinx", "sphinx-gallery", "quantem", "hyperspy","pydata_sphinx_theme","sphinx_design",]
dev = [
    "ruff",
    "basedpyright",
    "pre-commit",
    "pytest",
    "jsonschema",
    "anywidget>=0.9",
]


[tool.ruff]
line-length = 99
# data/__init__.pyi is generated by emdatabase._create_stubs; CI checks it is
# current, which only works if nothing else rewrites it.
extend-exclude = ["*.md", "*.pyi"]

[tool.ruff.lint]
select = ["E4", "E7", "E9", "F", "I"]

[tool.basedpyright]
typeCheckingMode = "standard"
include = ["emdatabase"]
exclude = ["**/__pycache__", "docs", "build"]
pythonVersion = "3.11"

[tool.pytest.ini_options]
# `slow` tests pull down the large datasets. They are deselected by default so
# CI checks that every source URL resolves without moving hundreds of megabytes
# on each of the nine matrix legs. Run them with `pytest -m slow`.
addopts = "-m 'not slow and not network'"
markers = [
    "slow: downloads a large dataset; deselected by default",
    "network: asks every source server whether it still has the file; run on a schedule",
]

[build-system]
requires = ["setuptools>=77.0", "wheel"]
build-backend = "setuptools.build_meta"

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

[tool.setuptools.package-data]
emdatabase = ["emdatabase.yaml", "*.pyi", "index/*.yaml", "index/*.yml", "index/*.json", "static/*.js", "static/*.css"]

[tool.setuptools.packages.find]
where = ["."]
include = ["emdatabase*"]
exclude = ["tests*", "*.tests*"]