nf-docs/pyproject.toml at main · ewels/nf-docs · 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
[project]
name = "nf-docs"
version = "0.2.1"
description = "Generate API documentation for Nextflow pipelines by querying the Nextflow Language Server"
readme = "README.md"
license = "Apache-2.0"
requires-python = ">=3.10"
authors = [
    { name = "nf-docs contributors" }
]
keywords = [
    "nextflow",
    "documentation",
    "bioinformatics",
    "pipeline",
    "lsp",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Environment :: Console",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Developers",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "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",
    "Topic :: Documentation",
    "Topic :: Scientific/Engineering :: Bio-Informatics",
]
dependencies = [
    "rich-click>=1.7",
    "pyyaml>=6.0",
    "jinja2>=3.0",
    "rich>=13.0",
    "httpx>=0.25",
    "markdown>=3.0",
    "pygments>=2.0",
    "pygments-csv-lexer>=0.1",
]

[project.optional-dependencies]
dev = [
    "pytest>=7.0",
    "pytest-cov>=4.0",
    "pytest-asyncio>=0.21",
    "ruff>=0.1",
    "ty>=0.0.1a0",
]
screenshots = [
    "playwright>=1.40",
    "pillow>=10.0",
]

[project.scripts]
nf-docs = "nf_docs.cli:main"
nf-docs-tailwind = "nf_docs.tailwind:main"

[project.urls]
Homepage = "https://ewels.github.io/nf-docs/"
Documentation = "https://ewels.github.io/nf-docs/"
Repository = "https://github.com/ewels/nf-docs"
Issues = "https://github.com/ewels/nf-docs/issues"
Bioconda = "https://bioconda.github.io/recipes/nf-docs/README.html"

[build-system]
requires = ["setuptools>=64"]
build-backend = "setuptools.build_meta"

[tool.setuptools.package-data]
nf_docs = ["templates/*"]

[tool.ruff]
line-length = 100
target-version = "py310"

[tool.ruff.lint]
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # Pyflakes
    "I",   # isort
    "B",   # flake8-bugbear
    "C4",  # flake8-comprehensions
    "UP",  # pyupgrade
]
ignore = [
    "E501",  # line too long (handled by ruff format)
]

[tool.ruff.format]
docstring-code-format = true

[tool.pytest.ini_options]
testpaths = ["tests"]
asyncio_mode = "auto"