solarfarmer-python-sdk/pyproject.toml at main · dnv-opensource/solarfarmer-python-sdk · 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
[build-system]
requires = ["setuptools>=68", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "dnv-solarfarmer"
version = "0.2.0rc1"
description = "SDK for SolarFarmer software, bankable solar PV calculation engine developed by DNV."
readme = "README.md"
requires-python = ">=3.10"
license = { text = "Apache-2.0" }
authors = [{ name = "DNV Green Power Monitor, Green Data Products", email = "solarfarmer@dnv.com" }]
maintainers = [{ name = "Green Data Products", email = "solarfarmer@dnv.com" }]
keywords = ["sdk", "api", "solarfarmer", "dnv", "python"]
classifiers = [
  "Intended Audience :: Information Technology",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "License :: OSI Approved :: Apache Software License",
  "Operating System :: OS Independent",
  "Topic :: Internet",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Topic :: Software Development :: Libraries",
  "Topic :: Software Development",
  "Topic :: Scientific/Engineering"
]

dependencies = [
  "pydantic>=2.0",
  "requests>=2.28",
  "tabulate>=0.9.0",
  ]

[project.optional-dependencies]
notebooks = [
  "ipykernel>=6.29,<8",
  "jupyterlab>=4.0,<6",
  "notebook>=7.0,<9"
]

all = [
  "dnv-solarfarmer[notebooks]",
  "pandas>=2.0",
  "matplotlib>=3.5",
]

[dependency-groups]
docs = [
  "zensical>=0.0.20",
  "mkdocstrings[python]>=0.26.1",
]

test = [
  "pytest>=7.0",
]

dev = [
  {include-group = "test"},
  "pre-commit>=3.0",
  "ruff>=0.5",
]

[project.urls]
Homepage = "https://www.dnv.com/software/services/solarfarmer/"
Repository = "https://github.com/dnv-opensource/solarfarmer-python-sdk"
Issues = "https://github.com/dnv-opensource/solarfarmer-python-sdk/issues"

[tool.setuptools.packages.find]
where = ["."]
include = ["solarfarmer*"]

[tool.ruff]
# Target Python 3.10+
target-version = "py310"
line-length = 100

# Exclude common directories
exclude = [
    ".git",
    ".venv",
    "venv",
    "__pycache__",
    "*.egg-info",
    "build",
    "dist",
    "docs",
]

[tool.ruff.lint]
# Enable these rule sets
select = [
    "E",      # pycodestyle errors
    "F",      # pyflakes
    "I",      # isort
    "UP",     # pyupgrade
    "B",      # flake8-bugbear
    "PTH",    # flake8-use-pathlib
]

# Disable specific rules if needed
ignore = [
    "E501",   # line too long (handled by formatter)
]

# Allow autofix for all enabled rules
fixable = ["ALL"]
unfixable = []

[tool.ruff.format]
# Use double quotes for strings
quote-style = "double"

# Indent with spaces
indent-style = "space"

[tool.pytest.ini_options]
markers = [
    "integration: marks tests that require SF_API_KEY and a live API connection (deselect with '-m not integration')",
]