mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-11-21 12:56:27 +00:00
976a2c8405
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
docker-build / platform-excludes (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
This change introduces a GitHub Action to automate release creation, including proper tagging and automatic addition of a development marker to the version. A hash is also appended to development versions to make their state easier to distinguish. Tests and release documentation have been updated to reflect the revised release workflow. Several files now retrieve the current version dynamically. The test --full-run option has been rename to --finalize to make clear it is to do commit finalization testing. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
121 lines
4.0 KiB
TOML
121 lines
4.0 KiB
TOML
[project]
|
|
name = "akkudoktor-eos"
|
|
dynamic = ["version"] # Get version information dynamically
|
|
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.11"
|
|
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"] }}
|
|
# version.txt must be generated
|
|
version = { file = "version.txt" }
|
|
|
|
[tool.setuptools.packages.find]
|
|
where = ["src/"]
|
|
include = ["akkudoktoreos"]
|
|
|
|
[tool.setuptools.package-data]
|
|
akkudoktoreos = ["*.json", "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
|
|
exclude = [
|
|
"tests",
|
|
"scripts",
|
|
]
|
|
output-format = "full"
|
|
|
|
[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.
|
|
"S", # Enable all `flake8-bandit` rules.
|
|
]
|
|
ignore = [
|
|
# Prevent errors due to ruff false positives
|
|
# ------------------------------------------
|
|
# On top of `Pyflakes (F)` to allow numpydantic Shape forward annotation
|
|
"F722", # forward-annotation-syntax-error: forward annotations that include invalid syntax.
|
|
|
|
# Prevent errors for existing sources. Should be removed!!!
|
|
# ---------------------------------------------------------
|
|
# On top of `Pyflakes (F)`
|
|
"F841", # unused-variable: Local variable {name} is assigned to but never used
|
|
# On top of `pydocstyle (D)`
|
|
"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", ]
|
|
|
|
[tool.mypy]
|
|
files = ["src", "tests"]
|
|
exclude = "class_soc_calc\\.py$"
|
|
check_untyped_defs = true
|
|
warn_unused_ignores = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "akkudoktoreos.*"
|
|
disallow_untyped_defs = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "sklearn.*"
|
|
ignore_missing_imports = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "deap.*"
|
|
ignore_missing_imports = true
|
|
|
|
[[tool.mypy.overrides]]
|
|
module = "xprocess.*"
|
|
ignore_missing_imports = true
|
|
|
|
[tool.commitizen]
|
|
# Only used as linter
|
|
name = "cz_conventional_commits"
|
|
version_scheme = "semver"
|
|
|
|
# Enforce commit message and branch style:
|
|
branch_validation = true
|
|
branch_pattern = "^(feat|fix|chore|docs|refactor|test)/[a-z0-9._-]+$"
|