version and changelog

CHANGELOG.rst

@@ -1,15 +1,19 @@
 Change Log
 ==========
 
-UNRELEASED
-----------
-* :bug: Fixed a test_cassette that was failing on a date check. Made it use a fixed date rather than doing it on today.
+v3.12.0 (1JUL21)
+----------------
+* :star: We added the `Context` object to pykechain that has full API access to the `Context` API in KE-chain v2021.6 and newer. You can add time period contexts, static location contexts and textlabel contexta and put them under a `context_group` if desired. This `Context` feature is now implemented limitly for `Activities` but in the coming period will be extended to support extensive usecases for the Forms NG featureset that is coming this fall. (KE-925)
+* :bug: Fixed a test cassette that was failing on a date check. Made it use a fixed date rather than doing it on today.
 * :bug: Fixed automatic compilation of the pykechain documentation on https://readthedocs.org/projects/pykechain/.
-* :+1: From now on python 3.5 is deprecated. We can now start to insert f-strings in our pykechain codebase.
+* :+1: From now on python 3.5 is deprecated. The lowest version we support is Python 3.6. We can now start to insert f-strings and variable type annotations in our pykechain codebase.
 * :+1: refactoring all models that were shadowed with a `<classname>2` to enable fast and smooth deprecation in July 2021.
-
-* :+1: When connecting to a server with a SSL certificate error which cannot be checked, we provide a message fast and dont retry. (KE-1052, #997)
 * :+1: We converted all type annotations in comments to proper type and variable annotations.
+* :+1: When connecting to a server with a SSL certificate error which cannot be checked, we provide a message fast and dont retry. (KE-1052, #997)
+
+# Backward Incompatible Changes
+
+* We dropped support for Python versions 3.5 and lower. Python 3.5 reached end of life in Sep 2020 and no more new releases will be made. Consider upgrading to a newer version of Python. See: https://www.python.org/dev/peps/pep-0478/
 
 v3.11.1 (15JUN21)
 -----------------

pykechain/__about__.py

@@ -2,7 +2,7 @@
 name = 'pykechain'
 description = 'KE-chain Python SDK'
 
-version = '3.11.1'
+version = '3.12.0'
 
 author = 'KE-works BV'
 email = 'support+pykechain@ke-works.com'

pykechain/client.py

@@ -3183,6 +3183,8 @@ def create_context(
         """
         Create a new Context object of a ContextType in a scope.
 
+        .. versionadded:: 3.12
+
         :param name: Name of the Context to be displayed to the end-user.
         :context_type: A type of Context, as defined in `ContextType` eg: STATIC_LOCATION, TIME_PERIOD
         :param scope: Scope object or Scope Id where the Context is active on.
@@ -3234,6 +3236,8 @@ def create_context(
     def delete_context(self, context: Context) -> None:
         """Delete the Context.
 
+        .. versionadded:: 3.12
+
         :param context: The context object to delete
         """
         context = check_type(context, Context, 'context')
@@ -3248,6 +3252,8 @@ def context(self, *args, **kwargs) -> Context:
         """
         Retrieve a single Context, see `contexts()` for available arguments.
 
+        .. versionadded:: 3.12
+
         :return: a single Contexts
         :rtype: Context
         """
@@ -3265,6 +3271,8 @@ def contexts(
         """
         Retrieve Contexts.
 
+        .. versionadded:: 3.12
+
         :param pk: (optional) retrieve a single primary key (object ID)
         :param context_type: (optional) filter on context_type (should be of `ContextType`)
         :param activities: (optional) filter on a list of Activities or Activity Id's

pykechain/models/activity.py

@@ -1036,7 +1036,7 @@ def context(self, *args, **kwargs) -> 'Context':
 
         See :class:`pykechain.Client.context` for available parameters.
 
-        .. versionadded:: 3.11
+        .. versionadded:: 3.12
 
         :return: a Context object
         """
@@ -1048,7 +1048,7 @@ def contexts(self, *args, **kwargs) -> List['Context']:
 
         See :class:`pykechain.Client.contexts` for available parameters.
 
-        .. versionadded:: 3.11
+        .. versionadded:: 3.12
 
         :return: a list of Context objects
         """
@@ -1060,7 +1060,7 @@ def create_context(self, *args, **kwargs) -> 'Context':
 
         See :class:`pykechain.Client.create_context` for available parameters.
 
-        .. versionadded:: 3.11
+        .. versionadded:: 3.12
 
         :return: a Context object
         """

pykechain/models/context.py

@@ -17,7 +17,7 @@ class Context(BaseInScope, TagsMixin):
     """
     A virtual object representing a KE-chain Context.
 
-    .. versionadded:: 3.11
+    .. versionadded:: 3.12
     """
 
     def __init__(self, json, **kwargs):