diff env/lib/python3.9/site-packages/shellescape-3.4.1.dist-info/DESCRIPTION.rst @ 0:4f3585e2f14b draft default tip

"planemo upload commit 60cee0fc7c0cda8592644e1aad72851dec82c959"

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/env/lib/python3.9/site-packages/shellescape-3.4.1.dist-info/DESCRIPTION.rst	Mon Mar 22 18:12:50 2021 +0000
@@ -0,0 +1,83 @@
+Source Repository: https://github.com/chrissimpkins/shellescape
+
+Description
+-----------
+
+The shellescape Python module defines the ``shellescape.quote()`` function that returns a shell-escaped version of a Python string.  This is a backport of the ``shlex.quote()`` function from Python 3.4.3 that makes it accessible to users of Python 3 versions < 3.3 and all Python 2.x versions.
+
+quote(s)
+--------
+
+>From the Python documentation:
+
+Return a shell-escaped version of the string s. The returned value is a string that can safely be used as one token in a shell command line, for cases where you cannot use a list.
+
+This idiom would be unsafe:
+
+.. code-block:: python
+
+	>>> filename = 'somefile; rm -rf ~'
+	>>> command = 'ls -l {}'.format(filename)
+	>>> print(command)  # executed by a shell: boom!
+	ls -l somefile; rm -rf ~
+
+
+``quote()`` lets you plug the security hole:
+
+.. code-block:: python
+
+	>>> command = 'ls -l {}'.format(quote(filename))
+	>>> print(command)
+	ls -l 'somefile; rm -rf ~'
+	>>> remote_command = 'ssh home {}'.format(quote(command))
+	>>> print(remote_command)
+	ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"''
+
+
+The quoting is compatible with UNIX shells and with ``shlex.split()``:
+
+.. code-block:: python
+
+	>>> remote_command = split(remote_command)
+	>>> remote_command
+	['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]
+	>>> command = split(remote_command[-1])
+	>>> command
+	['ls', '-l', 'somefile; rm -rf ~']
+
+
+Usage
+-----
+
+Include ``shellescape`` in your project setup.py file ``install_requires`` dependency definition list:
+
+.. code-block:: python
+
+	setup(
+	    ...
+	    install_requires=['shellescape'],
+	    ...
+	)
+
+
+Then import the ``quote`` function into your module(s) and use it as needed:
+
+.. code-block:: python
+
+	#!/usr/bin/env python
+	# -*- coding: utf-8 -*-
+
+	from shellescape import quote
+
+	filename = "somefile; rm -rf ~"
+	escaped_shell_command = 'ls -l {}'.format(quote(filename))
+
+
+Issue Reporting
+---------------
+
+Issue reporting is available on the `GitHub repository <https://github.com/chrissimpkins/shellescape/issues>`_
+
+
+
+