Update version to 1.4.0

Author: tornede

.gitignore

@@ -137,10 +137,18 @@ dmypy.json
 
 # todo
 todo.md
-config/database_credentials.cfg
-config/example*.cfg
+
+# Configs
+config/database_credentials.yml
+config/example_conditional_grid.yml
+config/example_general_usage.yml
+config/example_logtables.yml
+config/example_pause_and_continue.yml
 output/
 
 # codecarbon
 .codecarbon.config
 emissions.csv
+
+# development folder
+development/

.vscode/settings.json

@@ -1,8 +1,8 @@
 {
 	"autoDocstring.docstringFormat": "sphinx",
 	"editor.codeActionsOnSave": {
-		"source.organizeImports": true,
-		"formatting": true
+		"source.organizeImports": "explicit",
+		"formatting": "explicit"
 	},
 	"editor.formatOnSave": true,
 	"python.formatting.autopep8Args": [
@@ -58,5 +58,11 @@
 		"**/.git/subtree-cache/**": true,
 		"**/node_modules/*/**": true
 	},
-	"esbonio.sphinx.confDir": "${workspaceFolder}\\docs"
+	"esbonio.sphinx.confDir": "${workspaceFolder}\\docs",
+	"grammarly.selectors": [
+		{
+			"language": "restructuredtext",
+			"scheme": "file"
+		}
+	]
 }

CHANGELOG.rst

@@ -2,6 +2,21 @@
 Changelog
 =========
 
+v1.4.0 (20.02.2024)
+===================
+
+Feature
+-------
+- Add functionality to pause and later continue experiments. 
+- Change the supported database configuration file type to YAML.
+- Change the supported credentials file type to YAML.
+- Add support for ssh jump hosts in the database connection.
+
+Fix
+---
+- Fix a problem when executing fill_table that caused some entries to occur twice.
+- Temporary CodeCarbon files are automatically removed at termination.
+
 
 v1.3.2 (23.01.2024)
 ===================
@@ -10,6 +25,7 @@ Feature
 -------
 
 - Add `random_order` parameter to `PyExperimenter.execute()` to allow for random order of experiments.
+- Add pause functionality to `PyExperimenter` to allow for pausing the execution of experiments, which can be continued later on.
 
 Fix
 ---

config/database_credentials.cfg

@@ -0,0 +1,4 @@
+[CREDENTIALS]
+host=apollo.ai.uni-hannover.de 
+user=testuser_pyexperimenter
+password=c2ncKK3siSBkCuGE

config/example_database_credentials.cfg

@@ -0,0 +1,16 @@
+CREDENTIALS:
+  Database:
+    user: example_user
+    password: example_password
+  Connection:
+    Standard: 
+      server: example.mysqlserver.com
+    Ssh:
+      server: example.sshmysqlserver.com (address from ssh server)
+      address: example.sslserver.com
+      port: optional_ssh_port
+      remote_address: optional_mysql_server_address
+      remote_port: optional_mysql_server_port
+      local_address: optional_local_address
+      local_port: optional_local_port
+      passphrase: optional_ssh_passphrase

config/example_database_credentials.yml

@@ -17,67 +17,55 @@
 from recommonmark.parser import CommonMarkParser
 
 # -- Project information -----------------------------------------------------
-project = 'PyExperimenter'
-copyright = '2022, Tanja Tornede, Alexander Tornede, Lukas Fehring, Lukas Gehring, Helena Graf, Jonas Hanselle, Felix Mohr, Marcel Wever'
-author = 'Tanja Tornede, Alexander Tornede, Lukas Fehring, Lukas Gehring, Helena Graf, Jonas Hanselle, Felix Mohr, Marcel Wever'
+project = "PyExperimenter"
+copyright = "2022, Tanja Tornede, Alexander Tornede, Lukas Fehring, Lukas Gehring, Helena Graf, Jonas Hanselle, Felix Mohr, Marcel Wever"
+author = "Tanja Tornede, Alexander Tornede, Lukas Fehring, Lukas Gehring, Helena Graf, Jonas Hanselle, Felix Mohr, Marcel Wever"
 
 # The full version, including alpha/beta/rc tags
-release = '1.0'
+release = "1.0"
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'autoapi.extension',
-    'recommonmark',
-    'nbsphinx',
-    'sphinx_gallery.load_style'
-]
+extensions = ["sphinx.ext.autodoc", "autoapi.extension", "recommonmark", "nbsphinx", "sphinx_gallery.load_style"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = [
-    '_build',
-    'Thumbs.db',
-    '.DS_Store'
-]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 html_theme_options = {
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': True,
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": True,
     # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = [
-    '_static'
-]
+html_static_path = ["_static"]
 
 # -- Options for API ---------------------------------------------------------
-autoapi_dirs = ['../../py_experimenter']
+autoapi_dirs = ["../../py_experimenter"]