From 2a199d7dcb57e0a1913392d01141d76cd48e4d84 Mon Sep 17 00:00:00 2001 From: Remi Rampin Date: Wed, 31 Jan 2024 19:39:32 -0500 Subject: [PATCH] DOC: Update required Python version --- docs/graph.rst | 2 -- docs/install.rst | 13 +++++-------- docs/traceschema.rst | 4 +--- 3 files changed, 6 insertions(+), 13 deletions(-) diff --git a/docs/graph.rst b/docs/graph.rst index 5fafa1885..a90713358 100644 --- a/docs/graph.rst +++ b/docs/graph.rst @@ -3,8 +3,6 @@ Visualizing the Provenance Graph ******************************** -.. note:: If you are using a Python version older than 2.7.3, this feature will not be available due to `Python bug 57885 `__ related to sqlite3. - To generate a *provenance graph* related to the experiment execution, the ``reprounzip graph`` command should be used:: $ reprounzip graph graphfile.dot mypackfile.rpz diff --git a/docs/install.rst b/docs/install.rst index 039441276..f6b24d548 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -18,7 +18,7 @@ For Linux distributions, both *reprozip* and *reprounzip* components are availab Required Software Packages -------------------------- -Python 2.7.3 or greater, or 3.3 or greater is required to run ReproZip [#bug]_. If you don't have Python on your machine, you can get it from `python.org `__. You will also need the `pip `__ installer. +Python 3.7 or greater is required to run ReproZip. If you don't have Python on your machine, you can get it from `python.org `__. You will also need the `pip `__ installer. Besides Python and pip, each component or plugin to be used may have additional dependencies that you need to install (if you do not have them already installed in your environment), as described below: @@ -55,7 +55,6 @@ You can get the dependencies using the Yum packaging manager:: yum install python3 python3-devel gcc sqlite-devel openssl-devel libffi-devel -.. [#bug] ``reprozip`` and ``reprounzip graph`` will not work before 2.7.3 due to `Python bug 13676 `__ related to sqlite3. Python 2.6 is ancient and unsupported. .. [#vis1] `VisTrails v2.2.3+ `__ is required to run the workflow generated by the plugin. Installing *reprozip* @@ -87,12 +86,12 @@ For Mac OS X, only the *reprounzip* component is available. Binaries -------- -An installer containing Python 2.7, *reprounzip*, and all the plugins can be `downloaded from GitHub `__. +An installer containing Python 3, *reprounzip*, and all the plugins can be `downloaded from GitHub `__. Required Software Packages -------------------------- -Python 2.7.3 or greater, or 3.3 or greater is required to run ReproZip [#bug2]_. If you don't have Python on your machine, you can get it from `python.org `__; you should prefer a 2.x release to a 3.x one. You will also need the `pip `__ installer. +Python 3.7 or greater is required to run ReproZip. If you don't have Python on your machine, you can get it from `python.org `__; you should prefer a 2.x release to a 3.x one. You will also need the `pip `__ installer. Besides Python and pip, each component or plugin to be used may have additional dependencies that you need to install (if you do not have them already installed in your environment), as described below: @@ -114,7 +113,6 @@ You will need Xcode installed, which you can get from the Mac App Store, and the .. seealso:: :ref:`Why does reprounzip-vagrant installation fail with error "unknown argument: -mno-fused-madd" on Mac OS X? ` -.. [#bug2] ``reprozip`` and ``reprounzip graph`` will not work before 2.7.3 due to `Python bug 13676 `__ related to sqlite3. Python 2.6 is ancient and unsupported. .. [#vis2] `VisTrails v2.2.3+ `__ is required to run the workflow generated by the plugin. Installing *reprounzip* @@ -143,12 +141,12 @@ For Windows, only the *reprounzip* component is available. Binaries -------- -A 32-bit installer containing Python 2.7, *reprounzip*, and all the plugins can be `downloaded from GitHub `__. +A 32-bit installer containing Python 3, *reprounzip*, and all the plugins can be `downloaded from GitHub `__. Required Software Packages -------------------------- -Python 2.7.3 or greater, or 3.3 or greater is required to run ReproZip [#bug3]_. If you don't have Python on your machine, you can get it from `python.org `__; you should prefer a 2.x release to a 3.x one. You will also need the `pip `__ installer. +Python 3.7 or greater is required to run ReproZip. If you don't have Python on your machine, you can get it from `python.org `__; you should prefer a 2.x release to a 3.x one. You will also need the `pip `__ installer. Besides Python and pip, each component or plugin to be used may have additional dependencies that you need to install (if you do not have them already installed in your environment), as described below: @@ -165,7 +163,6 @@ Besides Python and pip, each component or plugin to be used may have additional | *reprounzip-vistrails* | None [#vis3]_ | +------------------------+------------------------------------------------------------------------+ -.. [#bug3] ``reprozip`` and ``reprounzip graph`` will not work before 2.7.3 due to `Python bug 13676 `__ related to sqlite3. Python 2.6 is ancient and unsupported. .. [#vis3] `VisTrails v2.2.3+ `__ is required to run the workflow generated by the plugin. .. [#windowshome] Windows Professional Edition is required for Docker, it will not work on Windows Home Edition; `see FAQ `__. diff --git a/docs/traceschema.rst b/docs/traceschema.rst index b7210f7e7..849561c33 100644 --- a/docs/traceschema.rst +++ b/docs/traceschema.rst @@ -55,7 +55,7 @@ The *mode* attribute is a binary OR of the following values (accessible from ``r ``executed_files`` '''''''''''''''''' -This is a variant of ``opened_files`` for file executions, i.e. `execve(2) `__ calls. There is no mode here (file is opened for reading by the call) and they are never directories; however, *workingdir*, *argv* (command-line arguments) and *envp* (environment variables) are added. *argv* is a list of arguments separated by null bytes (``0x00``) [#nullbytes]_, and *envp* is a list of ``VAR=value`` pairs separated by null (``0x00``) bytes [#nullbytes]_. Note that, again, failed executions (execve returns) are not logged. +This is a variant of ``opened_files`` for file executions, i.e. `execve(2) `__ calls. There is no mode here (file is opened for reading by the call) and they are never directories; however, *workingdir*, *argv* (command-line arguments) and *envp* (environment variables) are added. *argv* is a list of arguments separated by null bytes (``0x00``), and *envp* is a list of ``VAR=value`` pairs separated by null (``0x00``) bytes. Note that, again, failed executions (execve returns) are not logged. :: @@ -69,5 +69,3 @@ This is a variant of ``opened_files`` for file executions, i.e. `execve(2) `__ up to Python 2.7.3, which prevents it from reading text or blob fields with embedded null bytes.