The branch, twofactorauth has been updated via a9398f1bf6c434dfa4fe4fbf6e2a78916771909c (commit) from 25ae8bdeb523ff6266fdcdc47832a3afca55f88d (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- ----------------------------------------------------------------------- Summary of changes: x2go/__init__.py | 83 +++++++++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 39 deletions(-) The diff of changes is: diff --git a/x2go/__init__.py b/x2go/__init__.py index 00b7f95..cb1862d 100644 --- a/x2go/__init__.py +++ b/x2go/__init__.py @@ -19,42 +19,44 @@ """\ Python X2go is a python module that implements X2go client support for -the free X2go server project (U{http://www.x2go.org}) in Python. +the free X2go server project (U{http://wiki.x2go.org}) in Python. Introduction ============ - With Python X2go you can write your own X2go clients or embed X2go client + With Python X2go you can write your own X2go clients or embed X2go client features into already existing application environments. API Concept =========== - Python X2go consists of quite a few classes. Furthermore, - Python X2go is quite heavily taking advantage of Python\'s + Python X2go consists of quite a few classes. Furthermore, + Python X2go is quite heavily taking advantage of Python\'s threading features. When providing a library like Python - X2go, it is always quite a task to keep the library code - compatible with former versions of the same library. This is + X2go, it is always quite a task to keep the library code + compatible with former versions of the same library. This is intended for Python X2go, but with some restraints. - Python X2go only offers 5 public API classes. Once version 0.1.0 - has been released, we will try to keep these 5 public API classes - as compatible as possible to former versions of Python X2go. + Python X2go only offers 5 public API classes. With the release of + version 0.1.0.0, we will try to keep these 5 public API classes + of future releases as compatible as possible with versions of Python X2go + greater/equal than v0.1.0.0. - These classes are: + The 4 public API classes are: - L{X2goClient} --- a whole X2go client API - L{X2goSession} --- management of an individual X2go session started from an L{X2goClient} instance - L{X2goClientSettings} --- provide access to X2go (global and - user) config file(s) »settings« + user) configuration node »settings« - L{X2goClientPrinting} --- provide access to X2go (global and - user) config file(s) »printing« + user) configuration node »printing« - L{X2goSessionProfiles} --- provide access to X2go (global and - user) config file(s) »sessions« + user) configuration node »sessions« - Any other of the Python X2go classes may be subject to internal changes - and the way of addressing these classes in code may vary between versions. - If you directly use them in your own applications, so please be warned. + Any other of the Python X2go classes may be subject to internal changes + and the way of addressing these classes in code may vary between different + versions of Python X2go. If you directly use other than the 5 public API + classes in your own applications, so please be warned. API Structure @@ -84,11 +86,11 @@ API Structure »profile_name=<PROFILE_NAME_IN_SESSIONS_FILE>« or contain a whole set of L{X2goSession} parameters that can be used to start a - session manually (and not based on a pre-configured profile in either of the - »sessions« config files). + session manually (i.e. a session that is based on a pre-configured session profile + in either of the »sessions« config files). - The L{X2goClient.register_session()} method---in object-retrieval-mode---returns - an L{X2goSession} instance. With this instance you can then manage + The L{X2goClient.register_session()} method---in object-retrieval-mode---returns + an L{X2goSession} instance. With this instance you can then manage your X2go session:: import gevent, getpass @@ -99,12 +101,12 @@ API Structure reg_session_instance.start() # or resume the youngest session for gevent.sleep(60) - session.suspend() + reg_session_instance.suspend() # or alternatively: - session.terminate() + reg_session_instance.terminate() - Howto access---especially how to modify---the X2go client configuration - files »settings«, »printing«, »sessions« and »xconfig« (Windows only) + How to access---especially how to modify---the X2go client configuration + files »settings«, »printing«, »sessions« and »xconfig« (Windows only) is explained in detail with each class declaration in this API documentation. Please refer to the class docs of L{X2goClientSettings}, L{X2goClientPrinting}, L{X2goSessionProfiles} and L{X2goXServer}. @@ -112,24 +114,27 @@ API Structure Configuration and Session Management ==================================== - Python X2go strictly separates configuration management from - session management. The classes needed for session management + Python X2go strictly separates configuration management from + session management. The classes needed for session management / administration are supposed to only gain »read access« to the - classes handling the X2go client configuration files. + classes handling the X2go client configuration nodes. - NOTE: Each configuration file will be re-read whenever it is needed - by an X2go sesion or the X2goClient class itself. + A configuration node in Python X2go can be a file, a gconf database + section, a section in the Windows registry, etc. - Conclusively, any change to either of the configuration files + NOTE: Each configuration node will be re-read whenever it is needed + by an X2go sesion or the X2goClient class itself. + + Conclusively, any change to either of the configuration nodes will be reflected as a change in your X2go client behaviour: - - L{X2goSessionProfiles}: changes to a session profile in - the »sessions« file will be available for the next registered + - L{X2goSessionProfiles}: changes to a session profile in + the »sessions« node will be available for the next registered L{X2goSession} instance - - L{X2goClientPrinting}: on each incoming X2go print job the - »printing« configuration file will be re-read, thus you can + - L{X2goClientPrinting}: on each incoming X2go print job the + »printing« configuration node will be re-read, thus you can change your X2go client's print setup during a running session - - L{X2goClientSettings}: also the configuration file »settings« + - L{X2goClientSettings}: also the configuration node »settings« is re-read whenever needed in the course of X2go session management - L{X2goXServer} (Windows only): this class will only be initialized once (starting the XServer on Windows platforms) on construction @@ -138,17 +143,17 @@ Configuration and Session Management Dependencies ============ Python X2go takes advantage of the libevent/greenlet implementation - gevent (http://www.gevent.org). The least needed version of Python gevent + gevent (http://www.gevent.org). The least needed version of Python gevent is 0.13.0 (or above). - Python X2go (because of gevent) requires at least Python 2.6. Further recent + Python X2go (because of gevent) requires at least Python 2.6. Further recent information on Python X2go is available at: - U{http://das-netzwerkteam.de/site/?q=node/71} + U{http://wiki.x2go.org/python-x2go} Contact ======= If you have any questions concerning Python X2go, please sign up for the - x2go-user list (https://lists.berlios.de/mailman/listinfo/x2go-user) and post + x2go-dev list (https://lists.berlios.de/mailman/listinfo/x2go-dev) and post your questions, requests and feedbacks there. """ hooks/post-receive -- python-x2go.git (Python X2Go Client API) This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "python-x2go.git" (Python X2Go Client API).