Merge pull request #28 from python-mario/readme

Update readme

Author: python-mario-bot

README.rst

@@ -15,6 +15,27 @@ Your favorite plumbing snake 🐍🔧 with your favorite pipes, right in your sh
    :target: https://codecov.io/gh/python-mario/mario
 
 
+Installation
+============
+
+Get it with pip:
+
+.. code-block:: bash
+
+   python3.7 -m pip install mario
+
+If you're not inside a virtualenv, you might get a PermissionsError. In that case, try using:
+
+.. code-block:: bash
+
+    python3.7 -m pip install --user mario
+
+or for more flexibility and safety, use `pipx <https://github.com/pipxproject/pipx/>`_:
+
+.. code-block::bash
+
+     pipx install --python python3.7 mario
+
 Usage
 =====
 
@@ -513,15 +534,6 @@ Plugins
 Add new commands like ``map`` and ``reduce`` by installing mario plugins. You can try them out without installing by adding them to any ``.py`` file in your ``~/.config/mario/modules/``.
 
 
-Installation
-============
-
-Get it with pip:
-
-.. code-block:: bash
-
-   python3.7 -m pip install mario
-
 
 Caveats
 =======

dev-requirements.txt

@@ -2,22 +2,18 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    pip-compile --output-file dev-requirements.txt dev-requirements.in
+#    pip-compile --output-file=dev-requirements.txt dev-requirements.in
 #
 aiohttp==3.5.4
 alabaster==0.7.12         # via sphinx
 ansicolors==1.0.2         # via cuvner
-anyio==1.0.0              # via asks
-appdirs==1.4.3
+appdirs==1.4.3            # via black
 argh==0.26.2              # via watchdog
-asks==2.3.3
 asn1crypto==0.24.0        # via cryptography
 astroid==2.2.5            # via pylint
-async-exit-stack==1.0.1
-async-generator==1.10
 async-timeout==3.0.1      # via aiohttp
 atomicwrites==1.3.0       # via pytest
-attrs==19.1.0
+attrs==19.1.0             # via aiohttp, automat, black, hypothesis, pytest, service-identity, treq, twisted
 automat==0.7.0            # via twisted
 babel==2.6.0              # via sphinx
 black==19.3b0
@@ -26,18 +22,17 @@ bump2version==0.5.10
 certifi==2019.3.9         # via requests
 cffi==1.12.2              # via cryptography
 chardet==3.0.4            # via aiohttp, requests
-click==7.0
+click==7.0                # via black, cuvner
 constantly==15.1.0        # via twisted
 coverage==4.5.3
 cryptography==2.6.1       # via pyopenssl, service-identity
 cuvner==18.0.1
 docshtest==0.0.2
 docutils==0.14            # via readme-renderer, sphinx
 filelock==3.0.10          # via tox
-h11==0.9.0                # via asks
 hyperlink==19.0.0         # via twisted
 hypothesis==4.17.1
-idna==2.8                 # via hyperlink, requests, trio, twisted, yarl
+idna==2.8                 # via hyperlink, requests, twisted, yarl
 imagesize==1.1.0          # via sphinx
 incremental==17.5.0       # via cuvner, treq, twisted
 isort==4.3.17             # via pylint
@@ -47,13 +42,9 @@ lazy-object-proxy==1.3.1  # via astroid
 lockfile==0.12.2
 lxml==4.3.4
 markupsafe==1.1.1         # via jinja2
-marshmallow==3.0.0rc7
 mccabe==0.6.1             # via pylint
 more-itertools==7.0.0     # via pytest
 multidict==4.5.2          # via aiohttp, yarl
-mypy-extensions==0.4.1    # via mypy, trio-typing
-mypy==0.711               # via trio-typing
-outcome==1.0.0            # via trio
 packaging==19.0           # via pytest-sugar, sphinx
 parso==0.4.0
 pathtools==0.1.2          # via watchdog
@@ -68,7 +59,6 @@ pyhamcrest==1.9.0         # via twisted
 pylint==2.3.1
 pyopenssl==19.0.0         # via twisted
 pyparsing==2.4.0          # via packaging
-pyrsistent==0.15.2
 pytest-clarity==0.1.0a1
 pytest-cov==2.6.1
 pytest-sugar==0.9.2
@@ -79,10 +69,8 @@ readme-renderer==24.0     # via twine
 requests-toolbelt==0.8.0  # via twine
 requests==2.21.0
 service-identity==18.1.0  # via twisted
-six==1.12.0               # via astroid, automat, bleach, cryptography, cuvner, packaging, pyhamcrest, pyopenssl, pyrsistent, pytest, readme-renderer, tox, treq
-sniffio==1.1.0            # via anyio, trio
+six==1.12.0               # via astroid, automat, bleach, cryptography, cuvner, packaging, pyhamcrest, pyopenssl, pytest, readme-renderer, tox, treq
 snowballstemmer==1.2.1    # via sphinx
-sortedcontainers==2.1.0   # via trio
 sphinx-rtd-theme==0.4.3
 sphinx==2.0.1
 sphinxcontrib-applehelp==1.0.1  # via sphinx
@@ -92,17 +80,13 @@ sphinxcontrib-jsmath==1.0.1  # via sphinx
 sphinxcontrib-qthelp==1.0.2  # via sphinx
 sphinxcontrib-serializinghtml==1.1.3  # via sphinx
 termcolor==1.1.0          # via pytest-clarity, pytest-sugar
-toml==0.10.0
-toolz==0.9.0
+toml==0.10.0              # via black, tox
 tox==3.9.0
 tqdm==4.31.1              # via twine
 treq==18.6.0
-trio-typing==0.2.0
-trio==0.11.0
 twine==1.13.0
 twisted[tls]==19.2.0
-typed-ast==1.4.0          # via astroid, mypy
-typing-extensions==3.7.4  # via trio-typing
+typed-ast==1.4.0          # via astroid
 unidiff==0.5.5            # via cuvner
 urllib3==1.24.2
 virtualenv==16.4.3        # via tox
@@ -113,3 +97,6 @@ wrapt==1.11.1             # via astroid
 yapf==0.27.0
 yarl==1.3.0               # via aiohttp
 zope.interface==4.6.0     # via twisted
+
+# The following packages are considered to be unsafe in a requirements file:
+# setuptools==41.0.1        # via pyhamcrest, pytest, sphinx, tox, twine, zope.interface

requirements.in

@@ -11,4 +11,4 @@ toml
 asks
 marshmallow>=3.0rc1
 pyrsistent
-trio_typing
+trio-typing

requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    pip-compile --output-file requirements.txt requirements.in
+#    pip-compile --output-file=requirements.txt requirements.in
 #
 anyio==1.0.0              # via asks
 appdirs==1.4.3