changelog & deps updates for v0.12

Signed-off-by: Nicolas Höning <[email protected]>
FlexMeasures · Jan 4, 2023 · 4e90cbb · 4e90cbb
1 parent 23f67a2
commit 4e90cbb
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 32 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,10 +1,17 @@
 version: "3.4"
 
-# -----------------------------------------------
-# TODO:
-# * Add redis service
-# * Add a FlexMeasures worker service, maybe using https://docs.docker.com/compose/compose-file/#entrypoint
-# -----------------------------------------------
+# ------------------------------------------------------------------
+# This runs your local FlexMeasures code in a docker compose stack.
+# Two FlexMeasures instances are spun up, one for serving the web
+# UI & API, one to work on computation jobs.
+# The server is adding a toy account when it starts.
+# (user: [email protected], password: toy-password)
+# 
+# Instead of local code (which is useful for development purposes),
+# you can also use the official (and stable) FlexMeasures docker image
+# (lfenergy/flexmeasures). Replace the two `build` directives with
+# an `image`directive.
+# ------------------------------------------------------------------
 
 services:
   dev-db:

diff --git a/documentation/api/change_log.rst b/documentation/api/change_log.rst
@@ -5,7 +5,7 @@ API change log
 
 .. note:: The FlexMeasures API follows its own versioning scheme. This is also reflected in the URL, allowing developers to upgrade at their own pace.
 
-v3.0-5 | 2022-12-30
+v3.0-5 | 2023-01-04
 """""""""""""""""""
 
 - Introduced ``flex-model`` and ``flex-context`` fields to `/sensors/<id>/schedules/trigger` (POST). They are dictionaries and group pre-existing fields:

diff --git a/documentation/changelog.rst b/documentation/changelog.rst
@@ -3,14 +3,16 @@
 FlexMeasures Changelog
 **********************
 
-v0.12.0 | October XX, 2022
+v0.12.0 | January 4, 2023
 ============================
 
 .. warning:: After upgrading to ``flexmeasures==0.12``, users of API versions 1.0, 1.1, 1.2, 1.3 and 2.0 will receive ``"Deprecation"`` and ``"Sunset"`` response headers, and warnings are logged for FlexMeasures hosts whenever users call API endpoints in these deprecated API versions.
              The relevant endpoints are planned to become unresponsive in ``flexmeasures==0.13``.
 
 .. warning:: Upgrading to this version requires running ``flexmeasures db upgrade`` (you can create a backup first with ``flexmeasures db-ops dump``).
 
+.. note:: Read more on these features on `the FlexMeasures blog <http://flexmeasures.io/012-replay-custom-scheduling/>`__.
+
 New features
 -------------
 

diff --git a/documentation/cli/change_log.rst b/documentation/cli/change_log.rst
@@ -4,7 +4,7 @@
 FlexMeasures CLI Changelog
 **********************
 
-since v0.12.0 | November XX, 2022
+since v0.12.0 | January 04, 2023
 =================================
 
 * Add ``--resolution``, ``--timezone`` and ``--to-file`` options to ``flexmeasures show beliefs``, to show beliefs data in a custom resolution and/or timezone, and also to save shown beliefs data to a CSV file.
@@ -14,6 +14,7 @@ since v0.12.0 | November XX, 2022
 * Rename ``flexmeasures monitor tasks`` to ``flexmeasures monitor last-run``. 
 * Rename ``flexmeasures add schedule`` to ``flexmeasures add schedule for-storage`` (in expectation of more scheduling commands, based on in-built flex models). 
 
+
 since v0.11.0 | August 28, 2022
 ==============================
 
@@ -26,7 +27,6 @@ since v0.11.0 | August 28, 2022
 since v0.9.0 | March 25, 2022
 ==============================
 
-
 * Add CLI commands for showing data ``flexmeasures show accounts``, ``flexmeasures show account``, ``flexmeasures show roles``, ``flexmeasures show asset-types``, ``flexmeasures show asset``, ``flexmeasures show data-sources``, and ``flexmeasures show beliefs``.
 * Add ``flexmeasures db-ops resample-data`` CLI command to resample sensor data to a different resolution.
 * Add ``flexmeasures edit attribute`` CLI command to edit/add an attribute on an asset or sensor.

diff --git a/documentation/dev/docker-compose.rst b/documentation/dev/docker-compose.rst
@@ -96,7 +96,7 @@ Next, we put a scheduling job in the worker's queue. This only works because we
 
 .. code-block:: console
 
-    flexmeasures add schedule for-storage --sensor-id 2 consumption-price-sensor 3 \
+    flexmeasures add schedule for-storage --sensor-id 2 --consumption-price-sensor 3 \
         --start ${TOMORROW}T07:00+01:00 --duration PT12H --soc-at-start 50% \
         --roundtrip-efficiency 90% --as-job
 

diff --git a/requirements/app.txt b/requirements/app.txt
@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
+# This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
 #    pip-compile --output-file=requirements/app.txt requirements/app.in
@@ -119,7 +119,6 @@ idna==3.3
 importlib-metadata==4.12.0
     # via
     #   -r requirements/app.in
-    #   flask
     #   timely-beliefs
 inflect==6.0.0
     # via -r requirements/app.in

diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
+# This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
 #    pip-compile --output-file=requirements/dev.txt requirements/dev.in
@@ -74,7 +74,6 @@ tomli==2.0.1
 typing-extensions==4.3.0
     # via
     #   -c requirements/app.txt
-    #   black
     #   mypy
     #   setuptools-scm
 virtualenv==20.16.4

diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
+# This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
 #    pip-compile --output-file=requirements/docs.txt requirements/docs.in
@@ -29,10 +29,6 @@ idna==3.3
     #   requests
 imagesize==1.3.0
     # via sphinx
-importlib-metadata==4.12.0
-    # via
-    #   -c requirements/app.txt
-    #   sphinx
 jinja2==3.1.2
     # via
     #   -c requirements/app.txt
@@ -101,7 +97,3 @@ urllib3==1.26.12
     # via
     #   -c requirements/app.txt
     #   requests
-zipp==3.8.1
-    # via
-    #   -c requirements/app.txt
-    #   importlib-metadata
diff --git a/requirements/test.txt b/requirements/test.txt
@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
+# This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
 #    pip-compile --output-file=requirements/test.txt requirements/test.in
@@ -36,10 +36,6 @@ idna==3.3
     # via
     #   -c requirements/app.txt
     #   requests
-importlib-metadata==4.12.0
-    # via
-    #   -c requirements/app.txt
-    #   flask
 iniconfig==1.1.1
     # via pytest
 itsdangerous==2.1.2
@@ -119,7 +115,3 @@ wrapt==1.14.1
     # via
     #   -c requirements/app.txt
     #   deprecated
-zipp==3.8.1
-    # via
-    #   -c requirements/app.txt
-    #   importlib-metadata