Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed updating of pywbem.github.io from release instructions #15

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Removed updating of pywbem.github.io from release instructions #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
342 changes: 5 additions & 337 deletions pywbem/installation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,348 +26,16 @@ <h1 align="center">PyWBEM Client - Installation</h1>
</script>
<!-- end of page header -->

<h2>Downloads</h2>

<p>The following distribution archives are available for download:</p>

<a name="table1"></a>
<table border="1" style="width:100%">
<tr>
<th>Version</th>
<th>Released</th>
<th>Status</th>
<th>PyPI</th>
<th>Change Log</th>
<th>API Documentation</th>
</tr>
<tr>
<td>1.7.2</td>
<td>2024-04-18</td>
<td>Latest stable release, in fix mode</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.7.2">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.7.2/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.7.2/">API Documentation</a></td>
</tr>
<tr>
<td>1.6.3</td>
<td>2024-03-27</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.6.3">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.6.3/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.6.3/">API Documentation</a></td>
</tr>
<tr>
<td>1.5.0</td>
<td>2022-10-12</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.5.0">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.5.0/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.5.0/">API Documentation</a></td>
</tr>
<tr>
<td>1.4.2</td>
<td>2022-10-11</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.4.2">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.4.2/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.4.2/">API Documentation</a></td>
</tr>
<tr>
<td>1.3.0</td>
<td>2021-12-04</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.3.0">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.3.0/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.3.0/">API Documentation</a></td>
</tr>
<tr>
<td>1.2.1</td>
<td>2021-11-30</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.2.1">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.2.1/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/1.2.1/">API Documentation</a></td>
</tr>
<tr>
<td>1.1.3</td>
<td>2021-01-01</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.1.3">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_1.1/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_1.1/">API Documentation</a></td>
</tr>
<tr>
<td>1.0.3</td>
<td>2020-10-05</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/1.0.3">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_1.0/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_1.0/">API Documentation</a></td>
</tr>
<tr>
<td>0.17.6</td>
<td>2020-10-05</td>
<td>Stable release, fixed only in emergency cases</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.17.6">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.17/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.17/">API Documentation</a></td>
</tr>
<tr>
<td>0.16.0</td>
<td>2020-01-09</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.16.0">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.16/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.16/">API Documentation</a></td>
</tr>
<tr>
<td>0.15.0</td>
<td>2019-12-01</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.15.0">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.15/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.15/">API Documentation</a></td>
</tr>
<tr>
<td>0.14.6</td>
<td>2019-10-10</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.14.6">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.14/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.14/">API Documentation</a></td>
</tr>
<tr>
<td>0.13.1</td>
<td>2019-03-14</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.13.1">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.13/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.13/">API Documentation</a></td>
</tr>
<tr>
<td>0.12.6</td>
<td>2018-09-13</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.12.6">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.12/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.12/">API Documentation</a></td>
</tr>
<tr>
<td>0.11.0</td>
<td>2017-09-27</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.11.0">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.11/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.11/">API Documentation</a></td>
</tr>
<tr>
<td>0.10.1</td>
<td>2017-09-27</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.10.1">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.10/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.10/">API Documentation</a></td>
</tr>
<tr>
<td>0.9.1</td>
<td>2016-11-30</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.9.1">PyPI</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.9/changes.html">Change Log</a></td>
<td><a href="https://pywbem.readthedocs.org/en/stable_0.9/">API Documentation</a></td>
</tr>
<tr>
<td>0.8.4</td>
<td>2016-05-13</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.8.4">PyPI</a></td>
<td><a href="pywbem/doc/0.8.4/changelog.html">Change Log</a></td>
<td><a href="pywbem/doc/0.8.4/index.html">API Documentation</a></td>
</tr>
<tr>
<td>0.7.0</td>
<td>2008-12-12</td>
<td>Stable release, out of service</td>
<td><a href="https://pypi.python.org/pypi/pywbem/0.7.0">PyPI</a></td>
<td><a href="pywbem/doc/0.7.0/changelog.html">Change Log</a></td>
<td>N/A</td>
</tr>
</table>

<p>Older releases of the PyWBEM Client are available on
<a href="https://pypi.python.org/pypi/pywbem" target="_blank">PyPI</a>
and
<a href="https://github.com/pywbem/pywbem/tree/master/dist" target="_blank">GitHub</a>.</p>

<h2>Installation</h2>

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

<p>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.</p>

<p>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.</p>

<p>Installation of the PyWBEM Client is supported into the default system
Python, and (preferrable) into
<a href="http://docs.python-guide.org/en/latest/dev/virtualenvs/" target="_blank">virtual
Python environments</a>. For details, see the examples, below.</p>

<h3>Examples</h3>

<ul>
<li>
<p>Install latest version from PyPI into default system Python (assuming
OS-level prerequisites are already satisfied):</p>
<pre><code>sudo pip install pywbem
</code></pre>
</li>
<li>
<p>Install latest version from PyPI into new Python 2.7 virtual environment
(assuming OS-level prerequisites are already satisfied):</p>
<pre><code>mkvirtualenv -p python2.7 pywbem27
pip install pywbem
</code></pre>
</li>
<li>
<p>Install from master branch on GitHub into new Python 2.7 virtual environment
(assuming OS-level prerequisites are already satisfied):</p>
<pre><code>git clone git@github.com:pywbem/pywbem.git pywbem
cd pywbem/src
mkvirtualenv -p python2.7 pywbem27
python setup.py install
</code></pre>
</li>
<li>
<p><a name="inst_arch">
Install from a downloaded distribution archive
(links are in the <a href="pywbem/installation.html#table1">table above</a>),
into new Python 2.7 virtual environment, installing OS-level prerequisites
(such as Swig) as needed (requires sudo rights):</p>
<pre><code># 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
</code></pre>
</li>
</ul>

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

<h2>Installation in development mode</h2>

<p>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.</p>

<h3>Examples</h3>

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

<h2>Test of the installation</h2>

<p>To test that PyWBEM is sucessfully installed, start up a Python interpreter
and try to import the pywbem module:</p>
<pre><code>python -c "import pywbem"
</code></pre>

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

<h2>Troubleshooting</h2>

<p>Here are some hints in case of trouble during the installation of
PyWBEM:</p>

<h3>AttributeError for 'NullHandler' during mkvirtualenv on Python 2.6</h3>

<p>If the mkvirtualenv command fails on Python 2.6 with this error:</p>
<pre>
. . .
File "/usr/lib/python2.6/site-packages/stevedore/__init__.py", line 23, in <module>
LOG.addHandler(logging.NullHandler())
AttributeError: 'module' object has no attribute 'NullHandler'
</pre>
<p>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.</p>

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

<pre><code>sudo pip install stevedore==1.9</code></pre>

<h3>TypeError about StreamHandler argument 'stream' during mkvirtualenv on Python 2.6</h3>

<p>If the mkvirtualenv command fails on Python 2.6 with this error:</p>
<pre>
. . .
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'
</pre>
<p>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.</p>

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

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

<h3>Swig error 'Unrecognized option -builtin' during M2Crypto install</h3>

<p>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:</p>

<pre>swig error : Unrecognized option -builtin</pre>

<p>The solution is to use Swig v2.0 or higher.</p>

<p>If your operating system does not provide this version of Swig as a
package, you need to build it from its sources.</p>
<p>The PyWBEM Client can be installed directly from
<a href="https://pypi.python.org/pypi/pywbem" target="_blank">PyPI</a>.
using <code>pip install</code>.</p>

<p>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
<a href="pywbem/installation.html#inst_arch">Install from a downloaded
distribution archive</a>.</p>
For more details on the installation, see
<a href="https://pywbem.readthedocs.io/en/latest/intro.html#installation" target="_blank">Installation</a>.</p>

<h2>Next steps</h2>

Expand Down