.. _`Tutorial`:

Tutorial
========

This is a short tutorial about using pywbem. It is intended to be enough to get
people up and going who already know a bit about WBEM and CIM.

Python code examples this tutorial are shown using
`Jupyter Notebooks <jupyter-notebook-beginner-guide.readthedocs.io/>`_
(formerly known as IPython Notebooks), using the online
`Jupyter Notebook Viewer <http://nbviewer.jupyter.org/>`_.
This allows viewing them without having Jupyter installed locally.

In order to run or modify the examples, Jupyter Notebook must be installed,
and a running WBEM server should be available.

The following table lists the available tutorials:

======================================================== ==================================
View the tutorial                                        Download the Jupyter notebook
======================================================== ==================================
:nbview:`Making Connections <connections.ipynb>`         :nbdown:`connections.ipynb`
:nbview:`Python Data Model for CIM <datamodel.ipynb>`    :nbdown:`datamodel.ipynb`
:nbview:`EnumerateInstances <enuminsts.ipynb>`           :nbdown:`enuminsts.ipynb`
:nbview:`EnumerateInstanceNames <enuminstnames.ipynb>`   :nbdown:`enuminstnames.ipynb`
:nbview:`GetInstance <getinstance.ipynb>`                :nbdown:`getinstance.ipynb`
:nbview:`Create+DeleteInstance <createdeleteinst.ipynb>` :nbdown:`createdeleteinst.ipynb`
:nbview:`ModifyInstance <modifyinstance.ipynb>`          :nbdown:`modifyinstance.ipynb`
:nbview:`InvokeMethod <invokemethod.ipynb>`              :nbdown:`invokemethod.ipynb`
======================================================== ==================================

For the following topics, tutorials are not yet available:

* Pulled Enumerations
* ExecQuery
* Association Operations
* Class Operations
* Qualifier Operations
* WBEM Server
* WBEM Listener