Package pywbem

[frames] | no frames]

# Package pywbem

source code

PyWBEM provides a WBEM client library and some related utilities, written in pure Python.

The WBEM client library allows issuing operations to a WBEM server, using the CIM operations over HTTP (CIM-XML) protocol defined in the DMTF standards DSP0200 and DSP0201. See http://www.dmtf.org/standards/wbem for information about WBEM.

It is based on the idea that a good WBEM client should be easy to use and not necessarily require a large amount of programming knowledge. It is suitable for a large range of tasks from simply poking around to writing web and GUI applications.

- WBEMConnection : Main class of the WBEM client library and a good starting point to read about it.

The WBEM-related utilities included in this package are:

- mof_compiler : Script for compiling MOF files, can also be used as a module.
- cim_provider : Module for writing CIM providers in Python.
- cim_provider2 : Another module for writing CIM providers in Python.
- twisted_client : An experimental alternative WBEM client library that uses the Python `twisted` package.
- wbemcli : Script providing a WBEM client CLI as an interactive shell.

Importing the pywbem package causes a subset of symbols from its sub-modules to be folded into the target namespace.

The use of these folded symbols is shown for the example of class WBEMConnection:

    import pywbem
    conn = pywbem.WBEMConnection(...)

or:

    from pywbem import WBEMConnection
    conn = WBEMConnection(...)

or (less preferred):

    from pywbem import *
    conn = WBEMConnection(...)

The folded symbols' origin symbols in the sub-modules are also considered part of the public interface of the pywbem package.

Programs using sub-modules that are not part of the WBEM client library, or specific symbols that are not folded into the target namespace of the pywbem package need to import the respective sub-modules explicitly.

The use of such sub-modules is shown for the example of class cim_provider.CIMProvider:

    from pywbem import cim_provider
    provider = cim_provider.CIMProvider(...)

or:

    from pywbem.cim_provider import CIMProvider
    provider = CIMProvider(...)

or:

    import pywbem.cim_provider
    provider = pywbem.cim_provider.CIMProvider(...)

# Version

This version of PyWBEM is 0.8.0-dev.

The version number follows the conventions of semantic versioning (see http://semver.org/):

- M.N.U-dev : Preliminary version during development of the future M.N.U release.
- M.N.U-rc.1 : Preliminary version for release candidate 1 of the future M.N.U release.
- M.N.U : Final version for the M.N.U release.

When creating correspondingly versioned RPM packages, the hyphen (-) after the M.N.U version needs to be replaced by a tilde (~) to cause RPM to correctly treat the preliminary versions to be younger than the final version.

# Changes

The change log is in the NEWS file.

# Compatibility

PyWBEM has been tested with Python 2.7 on Windows and Linux, and with Python 2.6 on Linux (due to a restriction of the `M2Crypto` package on Windows).

Python 2.6 is the minimum version of Python that is supported.

Python 3 is not yet supported.

# Contributing

PyWBEM is on SourceForge (http://sourceforge.net/projects/pywbem/). Bug reports and discussion on the mailing list are welcome.

# License

PyWBEM is licensed with GNU LGPL v2. See the LICENSE.txt file.

Version: 0.8.0-dev

Submodules

- pywbem.cim_constants: Useful CIM constants.
- pywbem.cim_http: Send HTTP/HTTPS requests to a WBEM server.
- pywbem.cim_obj: Representations of CIM objects, and a case-insensitive dictionary.
- pywbem.cim_operations: CIM operations over HTTP.
- pywbem.cim_provider: Python CIM Providers (aka "nirvana")
- pywbem.cim_provider2: Python CIM Providers (aka "nirvana")
- pywbem.cim_types: Types to represent CIM typed values, and related conversion functions.
- pywbem.cim_xml: Functions to create XML documens and elements conforming to the DMTF standard DSP0201, Representation of CIM in XML, v2.2.
- pywbem.cimxml_parse
- pywbem.lex
- pywbem.mof_compiler
- pywbem.moflextab
- pywbem.mofparsetab
- pywbem.tupleparse: Tuple parser for the XML schema representing CIM messages.
- pywbem.tupletree: tupletree - Convert XML DOM objects to and from tuple trees.
- pywbem.twisted_client: pywbem.twisted - WBEM client bindings for Twisted Python.
- pywbem.wbemcli: A small utility to wrap up a PyWBEM session in a Python interactive console.
- pywbem.yacc