desdeo 1.2__tar.gz → 2.0.0__tar.gz

desdeo-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 The Multiobjective Optimization Group (http://www.mit.jyu.fi/optgroup/).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

desdeo-2.0.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.3
+Name: desdeo
+Version: 2.0.0
+Summary: DESDEO is a modular and open source framework for interactive multiobjective optimization.
+License: MIT
+Author: Giovanni Misitano
+Author-email: giovanni.a.misitano@jyu.fi
+Requires-Python: >=3.12,<3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: bayesian-optimization (>=1.0,<2.0)
+Requires-Dist: cvxpy[scip] (>=1.6.4,<2.0.0)
+Requires-Dist: greenlet (>=3.1.1,<4.0.0)
+Requires-Dist: gurobipy (>=12.0.0,<13.0.0)
+Requires-Dist: nevergrad (>=1.0.12,<2.0.0)
+Requires-Dist: numba (>=0.61.0,<0.62.0)
+Requires-Dist: numpy (>=2.2.0,<3.0.0)
+Requires-Dist: polars (>=1.17,<2.0)
+Requires-Dist: pyarrow (>=20.0.0,<21.0.0)
+Requires-Dist: pydantic (>=2.9,<3.0)
+Requires-Dist: pymoo (>=0.6.1.2,<0.7.0.0)
+Requires-Dist: pyomo (>=6.8,<7.0)
+Requires-Dist: pyparsing (>=3.0,<4.0)
+Requires-Dist: scipy (>=1.11.4,<2.0.0)
+Requires-Dist: shap (>=0.47.0,<0.48.0)
+Requires-Dist: sympy (>=1.0,<2.0)
+Requires-Dist: tsp-solver (>=0.1,<0.2)
+Description-Content-Type: text/markdown
+
+# DESDEO: the open-source software framework for interactive multiobjective optimization
+
+[![Documentation Status](https://img.shields.io/readthedocs/desdeo.svg?version=desdeo2&label=Documentation)](https://desdeo.readthedocs.io/en/latest/) ![Tests](https://img.shields.io/github/actions/workflow/status/industrial-optimization-group/DESDEO/unit_tests.yaml?branch=desdeo2&label=Tests)
+
+[![Discord server](https://dcbadge.vercel.app/api/server/TgSnUmzv5M)](https://discord.gg/TgSnUmzv5M)
+
+## Introduction
+
+DESDEO is an open-source framework for interactive multiobjective optimization
+methods. The framework contains implementations of both scalarization- and
+population-based interactive methods. There are currently no other open-source
+software frameworks that focus solely on the implementation of interactive
+multiobjective optimization methods.
+
+The mission of DESDEO is to increase awareness of the benefits of interactive
+multiobjective optimization methods, make interactive methods openly available,
+and to function as _the_ central hub for implementations of various interactive
+methods. Apart from existing methods, DESDEO offers various tools to facilitate
+the development of new methods and their application as well.  Another important
+goal of DESDEO is to answer the needs of decision makers and practitioners when
+it comes to modeling and solving real-life multiobjective optimization problems.
+
+In the bigger picture, DESDEO will be composed of three major components:
+
+1. The __core-logic__, which contains the algorithmic implementation of
+interactive methods, various tools related to multiobjective optimization, and
+means to model a variety of multiobjective optimization problems. The core-logic
+can be considered stable enough for use in research and applications.
+2. The __web-API__ (WIP), which implements a web-based application programming
+interface (API) to allow the use of the various functionalities found in
+DESDEO's core-logic through a web connection. The web-API implements also a
+database, which is a vital component for managing and enabling
+decision-support using the framework. __The
+web-API is currently under heavy development, and is subject to changes.__
+3. The __web-GUI__ (WIP), which implements a web-based interface for utilizing
+the interactive methods and tools for modeling and solving multiobjective
+optimization problems. __The web-GUI relies heavily on the web-API, and is also being actively developed currently, and therefore subject to sudden changes.__
+
+For developing and experimenting with interactive multiobjective optimization
+methods on a "grass root" level, the __core-logic__ provides the necessary
+tools.  For deploying interactive methods, the __web-API__ and the __web_GUI__
+play a central role.
+
+DESDEO is an open-source project and everybody is welcome to contribute!
+
+## Core-logic: key features
+
+DESDEO's core-logic offers various features that can facilitate the application and
+development of new interactive multiobjective optimization methods. Some
+of the key features include, but are not limited to,
+
+-   A powerful, pydantic-based, schema for modeling multiobjective optimization
+problem of various kinds. Including, analytically defined problems, data-based
+problems, surrogate-based problems, and simulation-based problems.
+Both continuous and (mixed-)integer problems are supported as well.
+-   Support to interface to many popular and powerful optimization software for
+solving multiobjective optimization problems. Including Gurobi, various solvers
+from the COIN-OR project, and nevergrad, for instance. 
+-   A wide assortment of modular software components for implementing existing
+and new interactive multiobjective optimization methods. For example, many
+scalarization functions and evolutionary operators for multiobjective
+optimization are available.
+-   An extensive documentation suitable for both newcomers to DESDEO and
+interactive multiobjective optimization in general, and seasoned veterans.
+
+## Web-API: key features
+
+DESDEO's web-API is currently under active development. Once it stabilized, its
+key features will be listed here. In the meantime, the interested user can
+follow (and contribute!) the development progress of the web-API in [this
+issue](https://github.com/industrial-optimization-group/DESDEO/issues/245).
+
+## Web-GUI: key features
+
+DESDEO's web-GUI is currently in a planning stage. Once its active development
+starts, an issue will be created for documenting its development, as is
+currently the case with the web-API.
+
+## Installation instructions
+
+For installing DESDEO, please see the documentation (TODO) for instructions.
+
+## Documentation
+
+Care has been taken to make sure DESDEO is well documented, making it accessible
+to both newcomers and seasoned users alike.  [The documentation of DESDEO is
+available online.](https://desdeo.readthedocs.io/en/desdeo2/)
+
+## Contributing
+
+As DESDEO is an open source-project, anybody is welcome to contribute.
+An extensive tutorial to get started contributing to DESDEO
+[is available in the documentation](https://desdeo.readthedocs.io/en/desdeo2/tutorials/contributing/).
+Be sure to check it out!
+
+For additional support for contributing to DESDEO,
+be sure to check out the DESDEO channels
+in the MCDM Community's Discord server. You may join the server
+[through this invite](https://discord.gg/TgSnUmzv5M).
+
+## License
+
+DESDEO is licensed under the MIT license. For more information,
+check the `LICENSE` file.
+
+## Citing DESDEO
+
+To cite DESDEO, please include the following reference:
+
+[Misitano, G., Saini, B. S., Afsar, B., Shavazipour, B., & Miettinen, K. (2021). DESDEO: The modular and open source framework for interactive multiobjective optimization. IEEE Access, 9, 148277-148295.](https://doi.org/10.1109/ACCESS.2021.3123825)
+
+```
+@article{misitano2021desdeo,
+  title={DESDEO: The modular and open source framework for interactive multiobjective optimization},
+  author={Misitano, Giovanni and Saini, Bhupinder Singh and Afsar, Bekir and Shavazipour, Babooshka and Miettinen, Kaisa},
+  journal={IEEE Access},
+  volume={9},
+  pages={148277--148295},
+  year={2021},
+  publisher={IEEE}
+}
+```
+
+__Note__: A new article describing the latest iteration of the framework,
+also known as _DESDEO 2.0_ is currently being prepared. The content of
+this repository's master branch is considered to be _DESDEO 2.0_.
+
+## Funding
+
+Currently, DESDEO's development is partly funded by two projects granted by the
+[Research Council of Finland](https://www.aka.fi/en/). The most recent ones
+include:
+
+- DESIDES (project 355346)
+- UTOPIA (project 352784)
+- DAEMON (project 322221)
+
+

desdeo-2.0.0/README.md

@@ -0,0 +1,137 @@
+# DESDEO: the open-source software framework for interactive multiobjective optimization
+
+[![Documentation Status](https://img.shields.io/readthedocs/desdeo.svg?version=desdeo2&label=Documentation)](https://desdeo.readthedocs.io/en/latest/) ![Tests](https://img.shields.io/github/actions/workflow/status/industrial-optimization-group/DESDEO/unit_tests.yaml?branch=desdeo2&label=Tests)
+
+[![Discord server](https://dcbadge.vercel.app/api/server/TgSnUmzv5M)](https://discord.gg/TgSnUmzv5M)
+
+## Introduction
+
+DESDEO is an open-source framework for interactive multiobjective optimization
+methods. The framework contains implementations of both scalarization- and
+population-based interactive methods. There are currently no other open-source
+software frameworks that focus solely on the implementation of interactive
+multiobjective optimization methods.
+
+The mission of DESDEO is to increase awareness of the benefits of interactive
+multiobjective optimization methods, make interactive methods openly available,
+and to function as _the_ central hub for implementations of various interactive
+methods. Apart from existing methods, DESDEO offers various tools to facilitate
+the development of new methods and their application as well.  Another important
+goal of DESDEO is to answer the needs of decision makers and practitioners when
+it comes to modeling and solving real-life multiobjective optimization problems.
+
+In the bigger picture, DESDEO will be composed of three major components:
+
+1. The __core-logic__, which contains the algorithmic implementation of
+interactive methods, various tools related to multiobjective optimization, and
+means to model a variety of multiobjective optimization problems. The core-logic
+can be considered stable enough for use in research and applications.
+2. The __web-API__ (WIP), which implements a web-based application programming
+interface (API) to allow the use of the various functionalities found in
+DESDEO's core-logic through a web connection. The web-API implements also a
+database, which is a vital component for managing and enabling
+decision-support using the framework. __The
+web-API is currently under heavy development, and is subject to changes.__
+3. The __web-GUI__ (WIP), which implements a web-based interface for utilizing
+the interactive methods and tools for modeling and solving multiobjective
+optimization problems. __The web-GUI relies heavily on the web-API, and is also being actively developed currently, and therefore subject to sudden changes.__
+
+For developing and experimenting with interactive multiobjective optimization
+methods on a "grass root" level, the __core-logic__ provides the necessary
+tools.  For deploying interactive methods, the __web-API__ and the __web_GUI__
+play a central role.
+
+DESDEO is an open-source project and everybody is welcome to contribute!
+
+## Core-logic: key features
+
+DESDEO's core-logic offers various features that can facilitate the application and
+development of new interactive multiobjective optimization methods. Some
+of the key features include, but are not limited to,
+
+-   A powerful, pydantic-based, schema for modeling multiobjective optimization
+problem of various kinds. Including, analytically defined problems, data-based
+problems, surrogate-based problems, and simulation-based problems.
+Both continuous and (mixed-)integer problems are supported as well.
+-   Support to interface to many popular and powerful optimization software for
+solving multiobjective optimization problems. Including Gurobi, various solvers
+from the COIN-OR project, and nevergrad, for instance. 
+-   A wide assortment of modular software components for implementing existing
+and new interactive multiobjective optimization methods. For example, many
+scalarization functions and evolutionary operators for multiobjective
+optimization are available.
+-   An extensive documentation suitable for both newcomers to DESDEO and
+interactive multiobjective optimization in general, and seasoned veterans.
+
+## Web-API: key features
+
+DESDEO's web-API is currently under active development. Once it stabilized, its
+key features will be listed here. In the meantime, the interested user can
+follow (and contribute!) the development progress of the web-API in [this
+issue](https://github.com/industrial-optimization-group/DESDEO/issues/245).
+
+## Web-GUI: key features
+
+DESDEO's web-GUI is currently in a planning stage. Once its active development
+starts, an issue will be created for documenting its development, as is
+currently the case with the web-API.
+
+## Installation instructions
+
+For installing DESDEO, please see the documentation (TODO) for instructions.
+
+## Documentation
+
+Care has been taken to make sure DESDEO is well documented, making it accessible
+to both newcomers and seasoned users alike.  [The documentation of DESDEO is
+available online.](https://desdeo.readthedocs.io/en/desdeo2/)
+
+## Contributing
+
+As DESDEO is an open source-project, anybody is welcome to contribute.
+An extensive tutorial to get started contributing to DESDEO
+[is available in the documentation](https://desdeo.readthedocs.io/en/desdeo2/tutorials/contributing/).
+Be sure to check it out!
+
+For additional support for contributing to DESDEO,
+be sure to check out the DESDEO channels
+in the MCDM Community's Discord server. You may join the server
+[through this invite](https://discord.gg/TgSnUmzv5M).
+
+## License
+
+DESDEO is licensed under the MIT license. For more information,
+check the `LICENSE` file.
+
+## Citing DESDEO
+
+To cite DESDEO, please include the following reference:
+
+[Misitano, G., Saini, B. S., Afsar, B., Shavazipour, B., & Miettinen, K. (2021). DESDEO: The modular and open source framework for interactive multiobjective optimization. IEEE Access, 9, 148277-148295.](https://doi.org/10.1109/ACCESS.2021.3123825)
+
+```
+@article{misitano2021desdeo,
+  title={DESDEO: The modular and open source framework for interactive multiobjective optimization},
+  author={Misitano, Giovanni and Saini, Bhupinder Singh and Afsar, Bekir and Shavazipour, Babooshka and Miettinen, Kaisa},
+  journal={IEEE Access},
+  volume={9},
+  pages={148277--148295},
+  year={2021},
+  publisher={IEEE}
+}
+```
+
+__Note__: A new article describing the latest iteration of the framework,
+also known as _DESDEO 2.0_ is currently being prepared. The content of
+this repository's master branch is considered to be _DESDEO 2.0_.
+
+## Funding
+
+Currently, DESDEO's development is partly funded by two projects granted by the
+[Research Council of Finland](https://www.aka.fi/en/). The most recent ones
+include:
+
+- DESIDES (project 355346)
+- UTOPIA (project 352784)
+- DAEMON (project 322221)
+

desdeo-2.0.0/desdeo/__init__.py

@@ -0,0 +1,9 @@
+"""Configuration stuff of the DESDEO framework."""
+
+from desdeo.core import _check_executables
+
+# List of required executables
+required_executables = ["bonmin", "cbc", "ipopt"]
+
+# Check for executables when the library is imported
+_check_executables(required_executables)

desdeo-2.0.0/desdeo/api/README.md

@@ -0,0 +1,73 @@
+# DESDEO web API
+Experimental. The instructions below assume that the current working directory
+is `desdeo/api` and that the DESDEO framework has been installed successfully
+with the extra dependencies in the `api` group.
+
+## API configuration
+
+The API configuration is handled by the settings found in `config.toml`. This
+file should be used for reading existing configuration parameters and adding
+new ones. Except for deployment (TODO).
+
+## Initializing the database
+
+To initialize the database, run the script `db_init.py` with the following command:
+
+```shell
+python db_init.py
+```
+
+This will create an initial databse, which allows testing for, e.g., testing
+the databse. However, the tests themselves (see below), do not depend on this
+database, and handle the database for running the tests on their own.
+
+Importantly, this will create an analyst user, which can be used to test out
+the end-points using the FastAPI generated documentation (see below). The
+default name of the analyst user will be 'analyst' with the password 'analyst'.
+
+This is mainly for testing purposes, which will create and manage a local
+dblite-databse.
+
+## Running the API
+
+To run the API, invoke `uvicorn` as followsi:
+
+```shell
+uvicorn --app-dir=./ app:app --reload
+```
+See the outputs of the command to figure out where the API is running. This is
+likely something along the lines `http:127.0.0.1:8000`, but may vary.
+
+## Exploring the API
+
+Once the API is running, its endpoints can be interactively explored by accessing
+`<api_url>/docs`. For example, `http:127.0.0:8000/docs`. The `analyst` user created by
+invoking `init_db.py` can be used to authorize and access the protected endpoints.
+
+## Running (unit) tests
+
+Pytest can be used to run tests relate to the API with the following command:
+
+```shell
+pytest
+```
+Again, it is assumed for the current working directory to be `desdeo/api`.
+Otherwise a lot of tests will be executed.
+
+## How the API works
+
+The API consists of two important concepts: __models__ and __routers__. At the
+core of the API, is a database.
+
+Models utilize SQLite to define databse models. In other words, it describes
+stuff we want to store in the databse. These models are very similar to
+pydantic models, and are almost interchangeable. One major difference is that
+the models are relational. This means that models often relate to each other.
+E.g., an `ArchiveEntryDB` is the child of the model `User`.
+
+Routers define HTTP endpoints to access and database and the models within.
+These endpoints often modify the contents of the database, e.g., by solving a
+problem with an interactive method, and then saving the solutions back to the
+database. Endpoints often make use of code found in the core-logic (the
+algorithms containing part of DESDEO), and are, in fact, a way to utilize this
+code through the web (which is the whole point of this API!).

desdeo-2.0.0/desdeo/api/__init__.py

@@ -0,0 +1,15 @@
+"""Exports for desdeo.api."""
+
+__all__ = [
+    "AuthDebugConfig",
+    "DatabaseDebugConfig",
+    "ServerDebugConfig",
+    "SettingsConfig",
+]
+
+from .config import (
+    AuthDebugConfig,
+    DatabaseDebugConfig,
+    ServerDebugConfig,
+    SettingsConfig,
+)

desdeo-2.0.0/desdeo/api/app.py

@@ -0,0 +1,40 @@
+"""The main FastAPI application for the DESDEO API."""
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from desdeo.api.config import AuthDebugConfig, SettingsConfig
+from desdeo.api.routers import (
+    problem,
+    reference_point_method,
+    session,
+    user_authentication,
+)
+
+if SettingsConfig.debug:
+    # debug and development stuff
+
+    app = FastAPI(
+        title="DESDEO (fast)API",
+        version="0.1.0",
+        description="A rest API for the DESDEO framework.",
+    )
+
+    app.include_router(user_authentication.router)
+    app.include_router(problem.router)
+    app.include_router(session.router)
+    app.include_router(reference_point_method.router)
+
+    origins = AuthDebugConfig.cors_origins
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=origins,
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+else:
+    # deployment stuff
+    pass

desdeo-2.0.0/desdeo/api/config.py

@@ -0,0 +1,69 @@
+"""Defines dataclasses to store configurations loaded from 'config.toml'."""
+
+import tomllib
+from pathlib import Path
+from typing import ClassVar
+
+from pydantic import BaseModel
+
+# Load the config data once
+config_path = Path(__file__).resolve().parent / "config.toml"
+with config_path.open("rb") as fp:
+    config_data = tomllib.load(fp)
+
+
+class SettingsConfig(BaseModel):
+    """General settings."""
+
+    debug: ClassVar[bool] = config_data["settings"]["debug"]
+
+
+class ServerDebugConfig(BaseModel):
+    """Server setup settings (development)."""
+
+    test_user_analyst_name: ClassVar[str] = config_data["server-debug"]["test_user_analyst_name"]
+    test_user_analyst_password: ClassVar[str] = config_data["server-debug"]["test_user_analyst_password"]
+    test_user_dm1_name: ClassVar[str] = config_data["server-debug"]["test_user_dm1_name"]
+    test_user_dm1_password: ClassVar[str] = config_data["server-debug"]["test_user_dm1_password"]
+    test_user_dm2_name: ClassVar[str] = config_data["server-debug"]["test_user_dm2_name"]
+    test_user_dm2_password: ClassVar[str] = config_data["server-debug"]["test_user_dm2_password"]
+
+
+class AuthDebugConfig(BaseModel):
+    """Authentication settings (development)."""
+
+    authjwt_secret_key: ClassVar[str] = config_data["auth-debug"]["authjwt_secret_key"]
+    authjwt_algorithm: ClassVar[str] = config_data["auth-debug"]["authjwt_algorithm"]
+    authjwt_access_token_expires: ClassVar[int] = config_data["auth-debug"]["authjwt_access_token_expires"]
+    authjwt_refresh_token_expires: ClassVar[int] = config_data["auth-debug"]["authjwt_refresh_token_expires"]
+    cors_origins: ClassVar[list[str]] = config_data["auth-debug"]["cors_origins"]
+
+
+class DatabaseDebugConfig(BaseModel):
+    """Database setting (development)."""
+
+    db_host: ClassVar[str] = config_data["database-debug"]["db_host"]
+    db_port: ClassVar[str] = config_data["database-debug"]["db_port"]
+    db_database: ClassVar[str] = config_data["database-debug"]["db_database"]
+    db_username: ClassVar[str] = config_data["database-debug"]["db_username"]
+    db_password: ClassVar[str] = config_data["database-debug"]["db_password"]
+    db_pool_size: ClassVar[int] = config_data["database-debug"]["db_pool_size"]
+    db_max_overflow: ClassVar[int] = config_data["database-debug"]["db_max_overflow"]
+    db_pool: ClassVar[bool] = config_data["database-debug"]["db_pool"]
+
+
+# class DatabaseDeployConfig(BaseModel):
+# # db_host: str = config_data["database-deploy"]["db_host"]
+# db_port: str = config_data["database-deploy"]["db_port"]
+# db_database: str = config_data["database-deploy"]["db_database"]
+# db_username: str = config_data["database-deploy"]["db_username"]
+# db_password: str = config_data["database-deploy"]["db_password"]
+# db_pool_size: int = config_data["database-deploy"]["db_pool_size"]
+# db_max_overflow: int = config_data["database-deploy"]["db_max_overflow"]
+# db_pool: bool = config_data["database-deploy"]["db_pool"]
+
+# class AuthDeployConfig(BaseModel):
+# authjwt_algorithm: str = config_data["auth-deploy"]["authjwt_algorithm"]
+# authjwt_access_token_expires: int = config_data["auth-deploy"]["authjwt_access_token_expires"]
+# authjwt_refresh_token_expires: int = config_data["auth-deploy"]["authjwt_refresh_token_expires"]
+# Note: authjwt_secret_key should be retrieved securely in production

desdeo-2.0.0/desdeo/api/config.toml

@@ -0,0 +1,53 @@
+[settings]
+debug = true
+
+# development configs
+[server-debug]
+test_user_analyst_name = "analyst"
+test_user_analyst_password = "analyst"
+test_user_dm1_name = "dm1"
+test_user_dm1_password = "dm1"
+test_user_dm2_name = "dm2"
+test_user_dm2_password = "dm2"
+
+# Auth configuration
+[auth-debug]
+authjwt_secret_key = "36b96a23d24cebdeadce6d98fa53356111e6f3e85b8144d7273dcba230b9eb18"
+authjwt_algorithm = "HS256"
+authjwt_access_token_expires = 15 # in minutes
+authjwt_refresh_token_expires = 30 # in minutes
+cors_origins = [
+    "http://localhost",
+    "http://localhost:8080",
+    "http://localhost:5173",
+]
+
+[auth-deploy]
+# TODO
+# secret key should be read from env DO NOT EXPOSE!!!!
+authjwt_algorithm = "HS256"
+authjwt_access_token_expires = 15  # in minutes
+authjwt_refresh_token_expires = 30 # in minutes
+
+# SQLite setup (enabled for local development)
+[database-debug]
+db_host = ""
+db_port = ""
+db_database = "sqlite:///./test.db"
+db_username = ""
+db_password = ""
+db_pool_size = 1
+db_max_overflow = 0
+db_pool = false
+
+# Database configuration (deployment)
+[database-deploy]
+# READ FROM ENV!!!
+# db_host = "localhost"
+# db_port = "5432"
+# db_database = "test"
+# db_username = "test"
+# db_password = "testpw"
+# db_pool_size = 20
+# db_max_overflow = 20
+# db_pool = true

desdeo-2.0.0/desdeo/api/db.py

@@ -0,0 +1,25 @@
+"""Database configuration file for the API."""
+
+from sqlmodel import Session, create_engine
+
+from desdeo.api.config import DatabaseDebugConfig, SettingsConfig
+
+if SettingsConfig.debug:
+    # debug and development stuff
+
+    # SQLite setup
+    engine = create_engine(DatabaseDebugConfig.db_database, connect_args={"check_same_thread": False})
+
+else:
+    # deployment stuff
+
+    # Postgresql setup
+    # check from config.toml
+    # SQLALCHEMY_DATABASE_URL = f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
+    pass
+
+
+def get_session():
+    """Yield the current database session."""
+    with Session(engine) as session:
+        yield session