Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

We wish to completely automate installation of OpenVisualizer. The work in SW-98 provides a standardized setup.py-based install for OpenVisualizer itself. However, we must extend this standardization to OpenVisualizer's dependencies. The pip installer provides dependency management for Python-based modules, and this page documents how we intend to use pip to implement SW-74.

...

In addition, core Python recently has decided to adopt pip as the primary installation mechanism for modules. So, we plan to use the setuptools module, on which pip is based, for the standard tree-based install. This approach provides for a simpler installation in the common case, and we can use pip to install OpenVisualizer itself. At the same time, we plan to retain use of the distutils module for native OS installation, which setuptools does not support.

Required Modules

The OpenVisualizer Confluence page lists the required modules. Some modules are Python based, and some are not. This section provides a detailed review.

...

If we don't use a traditional installer program, we must rely on Python's installation tools. Historically the distutils module provided this capability; however, core Python is switching to use of pip and the setuptools module upon which it is based for Python 3.4. A recent LWN article, Rationalizing Python packaging, describes the roadmap. Also see the Python Packaging User Guide as the definitive resource on the subject and setuptools documentation.

Use of pip and setuptools means that if they are installed, the user may install OpenVisualizer and its Python dependencies with a single command, either pip-based or setup.py-based. Eventually, pip and setuptools will be included with Python, so the user will not be required to install them manually.

...