PyWBEM Client - Installation

Downloads

The following distribution archives are available for download:

Version	Released	Status	PyPI	Change Log	API Documentation
1.7.2	2024-04-18	Latest stable release, in fix mode	PyPI	Change Log	API Documentation
1.6.3	2024-03-27	Stable release, out of service	PyPI	Change Log	API Documentation
1.5.0	2022-10-12	Stable release, out of service	PyPI	Change Log	API Documentation
1.4.2	2022-10-11	Stable release, out of service	PyPI	Change Log	API Documentation
1.3.0	2021-12-04	Stable release, out of service	PyPI	Change Log	API Documentation
1.2.1	2021-11-30	Stable release, out of service	PyPI	Change Log	API Documentation
1.1.3	2021-01-01	Stable release, out of service	PyPI	Change Log	API Documentation
1.0.3	2020-10-05	Stable release, out of service	PyPI	Change Log	API Documentation
0.17.6	2020-10-05	Stable release, fixed only in emergency cases	PyPI	Change Log	API Documentation
0.16.0	2020-01-09	Stable release, out of service	PyPI	Change Log	API Documentation
0.15.0	2019-12-01	Stable release, out of service	PyPI	Change Log	API Documentation
0.14.6	2019-10-10	Stable release, out of service	PyPI	Change Log	API Documentation
0.13.1	2019-03-14	Stable release, out of service	PyPI	Change Log	API Documentation
0.12.6	2018-09-13	Stable release, out of service	PyPI	Change Log	API Documentation
0.11.0	2017-09-27	Stable release, out of service	PyPI	Change Log	API Documentation
0.10.1	2017-09-27	Stable release, out of service	PyPI	Change Log	API Documentation
0.9.1	2016-11-30	Stable release, out of service	PyPI	Change Log	API Documentation
0.8.4	2016-05-13	Stable release, out of service	PyPI	Change Log	API Documentation
0.7.0	2008-12-12	Stable release, out of service	PyPI	Change Log	N/A

Older releases of the PyWBEM Client are available on PyPI and GitHub.

Installation

The PyWBEM Client can be installed quite easily by running its standard Python setup script (setup.py) with the "install" command, or by using pip install (which also invokes the setup script).

As of PyWBEM Client v0.8, the setup script has support for installing its prerequisites. This includes installing the M2Crypto Python package, installing any prerequisite OS-level packages, and installing or building Swig, if needed. For details, see the examples, below.

OS-level prerequisites are installed using new setup.py commands 'install_os' and 'develop_os'. They are supported for a number of well-known Linux distributions. For other Linux distributions, these commands display the OS-level packages that are needed. On Linux, these commands use 'sudo', so your userid needs to be authorized accordingly.

Installation of the PyWBEM Client is supported into the default system Python, and (preferrable) into virtual Python environments. For details, see the examples, below.

Examples

Install latest version from PyPI into default system Python (assuming OS-level prerequisites are already satisfied):
```
sudo pip install pywbem
```
Install latest version from PyPI into new Python 2.7 virtual environment (assuming OS-level prerequisites are already satisfied):
```
mkvirtualenv -p python2.7 pywbem27
pip install pywbem
```
Install from master branch on GitHub into new Python 2.7 virtual environment (assuming OS-level prerequisites are already satisfied):
```
git clone git@github.com:pywbem/pywbem.git pywbem
cd pywbem/src
mkvirtualenv -p python2.7 pywbem27
python setup.py install
```

Install from a downloaded distribution archive (links are in the table above), into new Python 2.7 virtual environment, installing OS-level prerequisites (such as Swig) as needed (requires sudo rights):

# Have pywbem-{version}.zip downloaded from the table, or run "pip download pywbem"
tar -xf pywbem-{version}.zip
cd pywbem-{version}
mkvirtualenv -p python2.7 pywbem27
python setup.py install_os install

The command syntax above is shown for Linux, but this works the same way on Windows and on other operating systems supported by Python.

Installation in development mode

The installation of PyWBEM in development mode is supported as well. Development mode means that any OS-level packages and Python packages needed for development of the PyWBEM Client are being made available. These packages are a superset of the packages needed for just using the PyWBEM client.

Examples

Install from master branch on GitHub into new Python 2.7 virtual environment, installing OS-level prerequisites as needed (requires sudo rights):
```
git clone git@github.com:pywbem/pywbem.git pywbem
cd pywbem/src
mkvirtualenv -p python2.7 pywbem27
python setup.py develop_os develop
```
Install from a downloaded distribution archive (links are in the table above), into new Python 2.7 virtual environment (assuming OS-level prerequisites are already satisfied):
```
# Have pywbem-{version}.zip downloaded
tar -xf pywbem-{version}.zip
cd pywbem-{version}
mkvirtualenv -p python2.7 pywbem27
python setup.py develop
```

Test of the installation

To test that PyWBEM is sucessfully installed, start up a Python interpreter and try to import the pywbem module:

python -c "import pywbem"

If you do not see any error messages after the import command, PyWBEM has been sucessfully installed and its dependencies are available.

Troubleshooting

Here are some hints in case of trouble during the installation of PyWBEM:

AttributeError for 'NullHandler' during mkvirtualenv on Python 2.6

If the mkvirtualenv command fails on Python 2.6 with this error:

  . . .
  File "/usr/lib/python2.6/site-packages/stevedore/__init__.py", line 23, in 
    LOG.addHandler(logging.NullHandler())
AttributeError: 'module' object has no attribute 'NullHandler'

then the 'stevedore' PyPI package is too recent(!) The owners of that package spent effort to remove the previously existing Python 2.6 support in some steps, starting with v1.10.

The solution is to use v1.9. Note that for virtualenvwrapper to use it, it must be installed into the system Python:

sudo pip install stevedore==1.9

TypeError about StreamHandler argument 'stream' during mkvirtualenv on Python 2.6

If the mkvirtualenv command fails on Python 2.6 with this error:

  . . .
  File "/usr/lib/python2.6/site-packages/virtualenvwrapper/hook_loader.py", line 101, in main
    console = logging.StreamHandler(stream=sys.stderr)
TypeError: __init__() got an unexpected keyword argument 'stream'

then the 'virtualenvwrapper' PyPI package is too old. A fix for that is currently only in the master branch of its source repository, and has not been released to PyPI yet (currently, v4.7.1 is the latest version on PyPI.

The solution is to clone its repository and to install from its working directory. Note that it must be installed into the system Python:

git clone https://bitbucket.org/dhellmann/virtualenvwrapper.git virtualenvwrapper
cd virtualenvwrapper
sudo python setup.py install

Swig error 'Unrecognized option -builtin' during M2Crypto install

On Python 2.x, PyWBEM uses the M2Crypto package from PyPI and installs it during its own installation. The M2Crypto package invokes the Swig tool during its installation. If the version of Swig is too old, the invocation of Swig fails with:

swig error : Unrecognized option -builtin

The solution is to use Swig v2.0 or higher.

If your operating system does not provide this version of Swig as a package, you need to build it from its sources.

The PyWBEM setup script is able to install Swig if available as a package, or otherwise to build it from its sources, as described in Install from a downloaded distribution archive.

Next steps

Have a look at: