mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-19 08:55:15 +00:00
94467e1a69
* Add package API documentation generation Add generation of the API documentation for akkudoktoreos and akkudoktoreosserver packages. The API documentation is generated by the Sphinx autosummary extension. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Enable Google style source commenting and documentation generation. Enable automatic documentation generation from Google style docstrings in the source. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Check Google style source commenting. Check Google style commenting by the appropriate ruff rules. Commenting is _NOT_ enforced. Missing docstrings are ignored. Minor commenting quirks of the code base are adapted. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Improve Markdown handling and switch to Markdown documentation. Switch to Markdown for the documentation files to improve the user and developer experience (see issue #181). Keep files with special directives for automatic API documentation in RST format. The directives expect RST. Also add dummy handling for openai/ swagger server documentation. The openai interface definition is for now taken from the fastapi PR as EOS will switch to fastAPI. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> --------- Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: Normann <github@koldrack.com>
75 lines
2.9 KiB
TOML
75 lines
2.9 KiB
TOML
[project]
|
|
name = "akkudoktor-eos"
|
|
version = "0.0.1"
|
|
authors = [
|
|
{ name="Andreas Schmitz", email="author@example.com" },
|
|
]
|
|
description = "This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period."
|
|
readme = "README.md"
|
|
license = {file = "LICENSE"}
|
|
requires-python = ">=3.10"
|
|
classifiers = [
|
|
"Development Status :: 3 - Alpha",
|
|
"Programming Language :: Python :: 3",
|
|
"Operating System :: OS Independent",
|
|
]
|
|
|
|
[project.urls]
|
|
Homepage = "https://github.com/Akkudoktor-EOS/EOS"
|
|
Issues = "https://github.com/Akkudoktor-EOS/EOS/issues"
|
|
|
|
[build-system]
|
|
requires = ["setuptools>=61.0"]
|
|
build-backend = "setuptools.build_meta"
|
|
|
|
[tool.setuptools.dynamic]
|
|
dependencies = {file = ["requirements.txt"]}
|
|
optional-dependencies = {dev = { file = ["requirements-dev.txt"] }}
|
|
|
|
[tool.setuptools.packages.find]
|
|
where = ["src/"]
|
|
include = ["akkudoktoreos", "akkudoktoreosserver", ]
|
|
|
|
[tool.setuptools.package-data]
|
|
akkudoktoreosserver = ["data/*.npz", ]
|
|
|
|
[tool.pyright]
|
|
# used in Pylance extension for language server
|
|
# type check is done by mypy, disable to avoid unwanted errors
|
|
typeCheckingMode = "off"
|
|
|
|
[tool.isort]
|
|
profile = "black"
|
|
|
|
[tool.ruff]
|
|
line-length = 100
|
|
|
|
[tool.ruff.lint]
|
|
select = [
|
|
"F", # Enable all `Pyflakes` rules.
|
|
"D", # Enable all `pydocstyle` rules, limiting to those that adhere to the
|
|
# Google convention via `convention = "google"`, below.
|
|
]
|
|
ignore = [
|
|
# On top of `Pyflakes (F)` to prevent errors for existing sources. Should be removed!!!
|
|
"F841", # unused-variable: Local variable {name} is assigned to but never used
|
|
# On top of `pydocstyle (D)` to prevent errors for existing sources. Should be removed!!!
|
|
"D100", # undocumented-public-module: Missing docstring in public module
|
|
"D101", # undocumented-public-class: Missing docstring in public class
|
|
"D102", # undocumented-public-method: Missing docstring in public method
|
|
"D103", # undocumented-public-function: Missing docstring in public function
|
|
"D104", # undocumented-public-package: Missing docstring in public package
|
|
"D105", # undocumented-magic-method: Missing docstring in magic method
|
|
"D106", # undocumented-public-nested-class: Missing docstring in public nested class
|
|
"D107", # undocumented-public-init: Missing docstring in __init__
|
|
"D417", # undocumented-param: Missing argument description in the docstring for {definition}: {name}
|
|
]
|
|
|
|
[tool.ruff.lint.pydocstyle]
|
|
convention = "google"
|
|
|
|
[tool.pytest.ini_options]
|
|
minversion = "8.3.3"
|
|
pythonpath = [ "src", ]
|
|
testpaths = [ "tests", ]
|