Update version to 1.3.0

Author: tornede

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,48 @@
+---
+name: Issue template
+about: Standard template for issues
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+- PyExperimenter version:
+- Database provider:
+- Python version:
+- Operating System:
+
+### Description
+
+Describe what you wanted to do and what (unexpected) behavior occurred.
+
+### Steps to Reproduce
+
+#### Used Configuration
+
+```text
+[PY_EXPERIMENTER]
+...
+```
+
+#### Used Experiment Function
+
+```python
+def run_experiment(keyfields: dict, result_processor: ResultProcessor, custom_fields: dict):
+    ...
+```
+
+#### Executed the Following Code
+
+```python
+experimenter = PyExperimenter(...)
+... 
+```
+
+#### Raised Following Rrror
+
+```text
+...
+```
+
+#### Database Looks like: ADD SCREENSHOT

.github/ISSUE_TEMPLATE/issue.md

@@ -0,0 +1,48 @@
+<!--- Provide a general summary of your changes in the title above. -->
+
+## Description
+<!--- Provide a short description of your changes. -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## Changes
+<!--- Explain your changes in detail here. -->
+
+#### Type Of Changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## How has This Been Tested?
+
+- Database provider:
+- Python version:
+- Operating System:
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Does this Close/Impact Existing Issues?
+<!--- Please link to all relevant issues. -->
+- Issue #X
+
+## What is Missing?
+<!--- Please provide any further information that is needed to close this PR. -->
+<!--- This could be another PR that is blocking this PR, or any further changes -->
+<!--- that need to be addressed in the future. -->
+
+## Checklist
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My change is based on the latest stage of the `develop` branch.
+- [ ] My change required a change of the documentation, which has been done.
+- [ ] I checked that the documentation can be build, visualizes everything as expected, and does not contain any warnings.
+- [ ] I have added/adapted tests to cover my changes.
+- [ ] The tests can be executed successfully.
+- [ ] The notebooks can be executed successfully.
+- [ ] The notebooks can be executed with `mysql` as provider.
+- [ ] I have added a description of the changes to `CHANGELOG.rst`.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -41,4 +41,4 @@ jobs:
         run: |
           source $VENV
           # Ignore the MySQL test, as it requires a MySQL server:
-          pytest --ignore=test/test_run_experiments/test_run_mysql_experiment.py --ignore=test/test_logtables/test_mysql.py
+          pytest --ignore=test/test_run_experiments/test_run_mysql_experiment.py --ignore=test/test_logtables/test_mysql.py --ignore=test/test_run_experiments/test_run_mysql_experiment.py --ignore=test/test_codecarbon/test_codecarbon_core_functions_mysql.py --ignore=test/test_codecarbon/test_integration_mysql.py

.github/workflows/tests.yml

@@ -139,4 +139,8 @@ dmypy.json
 todo.md
 config/database_credentials.cfg
 config/example*.cfg
-output/
+output/
+
+# codecarbon
+.codecarbon.config
+emissions.csv

.gitignore

@@ -58,5 +58,5 @@
 		"**/.git/subtree-cache/**": true,
 		"**/node_modules/*/**": true
 	},
-	"esbonio.sphinx.confDir": "${workspaceFolder}/docs/source"
+	"esbonio.sphinx.confDir": "${workspaceFolder}\\docs"
 }

.vscode/settings.json

@@ -2,6 +2,34 @@
 Changelog
 =========
 
+v1.3.0 (23.06.2023)
+===================
+
+Feature
+-------
+
+- Added ``CodeCarbon`` to automatically measure carbon emissions of experiments.
+- Improved issue template.
+- Added template for pull requests.
+- Extended documentation for development / how to contribute to ``PyExperimenter``
+
+
+Examples
+--------
+
+- Updated examples to utilize ``CodeCarbon`` functionality.
+
+Changed
+-------
+
+- Replaced ``mysql-connector-python`` dependency to use ``pymysql`` instead.
+
+Fix
+---
+
+- Bugfix escaping of values in sql statements.
+
+
 v1.2.1 (21/04/2023)
 ===================
 

CHANGELOG.rst

@@ -0,0 +1,62 @@
+
+.. _3rd_party:
+
+================================
+Usage of 3rd Party Dependencies
+================================
+
+This part of the documentation refers to 3rd party dependencies, that need to be used actively during development. It contains a short description of the dependency and an explanation on how it is meant to be used for ``PyExperimenter``. 
+
+.. _use_poetry:
+
+--------
+Poetry
+--------
+
+`Poetry <poetry_>`_ is a dependency management and packaging tool for Python. It allows to declare the dependencies of your projects and it will manage (install / update) them for you. It also allows to build a package which can be uploaded to a package repository and installed via ``pip``. 
+
+For installation instructions and further useful commands than the ones listed below, please refer to the `Poetry documentation <poetry_docs_>`_. Please make sure to follow the described steps: do NOT use ``pip`` or ``conda`` for installation of Poetry itself, and make sure to add Poetry to your PATH. 
+
+If you checked out the ``PyExperimenter`` repository, you can install the development dependencies using Poetry. To this end, navigate into the git project folder and execute the following command which will instll the excact versions used for the development of ``PyExperimenter``:
+
+.. code-block::
+
+        poetry install
+
+You can add a new core dependency that is needed to use ``PyExperimenter`` using the first of the following commands, which will add the latest version of the package to the ``pyproject.toml`` file. If you want to add a specific version, you can use the second following command:
+
+.. code-block::
+
+        poetry add <package_name>
+        # or
+        poetry add "<package_name>>=<version>"
+
+A development dependency can be added using the following command, which will add the latest or the given version of the package to the ``dev`` dependency group:
+
+.. code-block::
+
+        poetry add --group dev <package_name>
+        # or
+        poetry add --group dev "<package_name>>=<version>"
+
+The ``poetry.lock`` file will be updated automatically, when doing so. Therefore, ``poetry`` tries to resolve the dependencies. If needed dependencies will be updated. If you want to update the ``poetry.lock`` file manually (resolve dependencies with the most current libary version), you can use the following command:
+
+.. code-block::
+
+        poetry update
+
+
+The version of ``PyExperimenter`` can be easily updated using the following command. This will update the version in the ``pyproject.toml`` file.
+
+.. code-block::
+        
+        poetry version <major/minor/patch/prerelease>
+
+Finally, if you want to build a package, you can use the following command, which will create a ``dist`` folder containing the built package:
+
+.. code-block::
+
+        poetry build
+
+.. _poetry: https://python-poetry.org/
+.. _poetry_docs: https://python-poetry.org/docs/