Skip to content

Update README.rst #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andyhasit wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.rst #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,34 @@ Magicinvoke is a Python (2.7 and 3.4+) library based on
`Invoke <http://pyinvoke.org>`_.

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 <https://magicinvoke.readthedocs.io>`_.

Expand Down