From 3a2b9304a20b22fe6db7a4ea0aea4792a47c53de Mon Sep 17 00:00:00 2001 From: Andrew Buchan Date: Wed, 5 Jul 2023 10:34:42 +0100 Subject: [PATCH] Update README.rst Added warning in readme. --- README.rst | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 26f07fad..539ca376 100644 --- a/README.rst +++ b/README.rst @@ -5,10 +5,34 @@ Magicinvoke is a Python (2.7 and 3.4+) library based on `Invoke `_. It adds ``get_params_from_ctx``, ``skippable``, and ``magictask``, -as well as including a patched version of ``invoke`` with -support for ``*args`` and ``**kwargs`` on tasks, +as well as support for ``*args`` and ``**kwargs`` on tasks, some clearer exceptions, and some minor bugfixes. +WARNING +------- + +Installing magicmock will REPLACE the source code of any existing invoke installation +with the patched copie of invoke included in magicmock. However, it does not update the +.dist-info directory, so it will appear that you have whatever version of invoke you +installed (e.g. 1.7.3) but the code will in fact be magicmock's patched copy, which is +currently at 1.2. + +You can check with: + +.. code-block:: python + + >>> import invoke + >>> invoke.__version__ + '1.2.0' + + +This may lead to unexpected behaviour, and features added after 1.2 will not be available. + +Parallel installers (such as poetry) may also mangle the file in invoke as a result of this. + +We are looking into alternative ways of implementing magicmock's functionality, but until then, +please use with caution. + For docs and to see what magicinvoke has to offer you, `see here `_.