.. _tutorial:

========
Tutorial
========

:Author:    Stefan Eletzhofer
:Date:      2012-05-21

Abstract
========

This chapter aims to serve as a *tutorial* for newcomers.

.. note:: This is very much Work In Progress

Prerequisites
-------------

Prerequisites to follow tis tutorials are:

- Access to a Windchill (TM) Server with **nexiles.tools** installed, for
  more see :ref:`installation-prerequisites`

- A *user account* on the Windchill (TM) Server.  The user should have
  full access to some *product context*, to be able to follow all examples.

- Python_ installed on your machine.

.. _Python: http://www.python.org

Windows Notes
-------------

Windows users should be able to follow along and see no differences at all.
Please make sure that you have Python set up correctly as detailed in
:ref:`installation`.

Notational Conventions
----------------------

I'm using the following textual notation to denote a line you should enter
on the *command line shell*::

    $ echo "hello world"
    hello world

The above example would mean that you'd type `echo "hello world"` and hit
enter.  The next line is the expected output.  Please do note that the `$ `
is **not** part of the example -- it denotes the *prompt* of the command
line shell.

If the command is too long to be formatted nicely, we use the following
notation.  Note that you may leave out the backslash and type everything
in one line::

    $ echo "some verry long command" | sed -e 's,verry,very' > \
    /tmp/foo.txt

The following notation denotes a line to be typed in the **Python REPL**::

    >>> print("this is the python REPL")
    this is the python REPL

Again, the '>>> '  is **not** part of the example.

If the code line is too long to be formatted nicely, we'll use this::

    >>> result = api_call(this=1, is=2, very=3 long=4, indeed=5,
    ... and=6, we=7, continue=8, on_the_next_line=True)

Here, after the "indeed=5," you're free to either continue typing, or
to press `enter`.  The **Python REPL** will notice that the line is not
complete and will use the prompt '... ' to indicate that.  Again, you're
not typing the '... ', this is done by the **Python REPL**.  Try it out!

Getting Help
------------

If you're stuck on something, either drop us a note via mail, or head over
to our IRC channel `#nexiles` at freenode.

Issue Tracker, WiKi
-------------------

There's a issue tracker over at github:

https://github.com/nexiles/nexiles.tools.api/issues

And we even have a Wiki:

https://github.com/nexiles/nexiles.tools.api/wiki

Contents
========

.. toctree::
   :maxdepth: 2

   introduction
   queries
   low_level_api

.. vim: set ft=rst tw=75 nocin nosi ai sw=4 ts=4 expandtab: