This is an automated email from the git hooks/post-receive script. x2go pushed a commit to annotated tag 0.2.0.3 in repository x2goclient. commit b7fa23be3f50174817a11036b085ad8a54ba7f99 Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Fri Jun 8 23:12:00 2012 +0200 Add __doc__ strings to __init__.py and frontend.py. --- debian/changelog | 1 + pyhoca/cli/__init__.py | 7 ++++- pyhoca/cli/frontend.py | 78 ++++++++++++++++++++++++++++++++++++++++++-------- 3 files changed, 73 insertions(+), 13 deletions(-) diff --git a/debian/changelog b/debian/changelog index b4461ba0..a367c02e 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,6 +6,7 @@ pyhoca-cli (0.1.4.3-0~x2go1) UNRELEASED; urgency=low * Add python-suport (>=0.90) as dependency. Fix project name in control file. * Add proper license to copyright file. + * Add __doc__ strings to __init__.py and frontend.py. -- Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Wed, 07 Sep 2011 20:32:00 +0200 diff --git a/pyhoca/cli/__init__.py b/pyhoca/cli/__init__.py index d7fb69bc..f24d940f 100644 --- a/pyhoca/cli/__init__.py +++ b/pyhoca/cli/__init__.py @@ -18,7 +18,12 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -STILL UNDOCUMENTED +PyHoca-CLI is a simple command-line tool that allows the launching of +X2Go sessions. + +For further information on X2Go, please visit the X2Go wiki: +http://wiki.x2go.org + """ __VERSION__ = "0.1.4.3" diff --git a/pyhoca/cli/frontend.py b/pyhoca/cli/frontend.py index d79bcd43..b957faec 100644 --- a/pyhoca/cli/frontend.py +++ b/pyhoca/cli/frontend.py @@ -64,7 +64,8 @@ def runtime_error(m, parser=None, exitcode=-1): class PyHocaCLI(x2go.X2goClient): """\ - STILL UNDOCUMENTED + L{PyHocaCLI} is a command-line X2Go Client wrapping around Python X2Go (C{X2goClient} class). + """ x2go_session_hash = None @@ -75,7 +76,13 @@ class PyHocaCLI(x2go.X2goClient): def list_sessions(self, s_hash): """\ - STILL UNDOCUMENTED + List up server-side available sessions for the logged in user. + + The list of available session is printed to stdout. + + @param s_hash: session UUID + @type s_hash: C{str} + """ # retrieve a session list print @@ -110,7 +117,14 @@ class PyHocaCLI(x2go.X2goClient): def list_desktops(self, s_hash): """\ - STILL UNDOCUMENTED + List up server-side available desktop sessions that are + available for sharing to the logged in user. + + The list of sharable desktop sessions is printed to stdout. + + @param s_hash: session UUID + @type s_hash: C{str} + """ # retrieve a desktop list print @@ -129,6 +143,12 @@ class PyHocaCLI(x2go.X2goClient): print def list_profiles(self): + """\ + List up client-side configured session profile configurations. + + The list of session profiles is printed to stdout. + + """ # retrieve a session list print print "Available X2Go session profiles" @@ -143,7 +163,12 @@ class PyHocaCLI(x2go.X2goClient): def clean_sessions(self, s_hash): """\ - STILL UNDOCUMENTED + Clean all running/suspended sessions on the X2Go server that the session with UUID C{s_hash} + is connected to. + + @param s_hash: session UUID + @type s_hash: C{str} + """ _profiles = self._X2goClient__get_profiles() if self.args.session_profile and _profiles.has_profile(self.args.session_profile): @@ -156,7 +181,11 @@ class PyHocaCLI(x2go.X2goClient): def new_session(self, s_hash): """\ - STILL UNDOCUMENTED + Launch a new X2Go session via the C{X2goSession} object with session UUID C{s_hash}. + + @param s_hash: session UUID + @type s_hash: C{str} + """ # start a new session and run a command self.logger('starting a new X2Go session', loglevel=x2go.loglevel_INFO, ) @@ -186,7 +215,11 @@ class PyHocaCLI(x2go.X2goClient): def resume_session(self, s_hash): """\ - STILL UNDOCUMENTED + Use C{X2goSession} object with session UUID C{s_hash} to resume a server-side suspended X2Go session. + + @param s_hash: session UUID + @type s_hash: C{str} + """ # resume a running session self.logger('resuming X2Go session: %s' % self.args.resume, loglevel=x2go.loglevel_INFO, ) @@ -202,7 +235,11 @@ class PyHocaCLI(x2go.X2goClient): def share_desktop_session(self, s_hash): """\ - STILL UNDOCUMENTED + Use C{X2goSession} object with session UUID C{s_hash} to share a server-side X2Go desktop session that is available for sharing. + + @param s_hash: session UUID + @type s_hash: C{str} + """ # start a new session and run a command _desktop = self.args.share_desktop @@ -216,7 +253,11 @@ class PyHocaCLI(x2go.X2goClient): def suspend_session(self, s_hash): """\ - STILL UNDOCUMENTED + Suspend X2Go Session object with session UUID C{s_hash}. + + @param s_hash: session UUID + @type s_hash: C{str} + """ # send a suspend request to a session self.logger('requesting X2Go session suspend of session: %s' % self.args.suspend, loglevel=x2go.loglevel_INFO, ) @@ -241,7 +282,10 @@ class PyHocaCLI(x2go.X2goClient): def terminate_session(self, s_hash): """\ - STILL UNDOCUMENTED + Terminate X2Go Session with session UUID C{s_hash}. + + @param s_hash: session UUID + @type s_hash: C{str} """ # send a terminate request to a session @@ -267,7 +311,16 @@ class PyHocaCLI(x2go.X2goClient): def __init__(self, args, logger=None, liblogger=None): """\ - STILL UNDOCUMENTED + L{PyHocaCLI} Class constructor. + + @param args: a class with properties representing the command-line options that are available to L{PyHocaCLI} instances. + @type args: C{argparse.ArgumentParser} (or similar) + @param logger: you can pass an L{X2goLogger} object to the + L{PyHocaCLI} constructor for logging application events + @type logger: Python X2Go C{X2goLogger} instance + @param liblogger: you can pass an L{X2goLogger} object to the + L{PyHocaCLI} constructor for logging application events, this object is forwarded to the C{X2goClient} class in Python X2Go + @type liblogger: Python X2Go C{X2goLogger} instance """ self.args = args @@ -342,7 +395,8 @@ class PyHocaCLI(x2go.X2goClient): def authenticate(self): """\ - STILL UNDOCUMENTED + Authenticate this L{PyHocaCLI} instance with the remote X2Go server. + """ connected = False force_password_auth = False @@ -390,7 +444,7 @@ class PyHocaCLI(x2go.X2goClient): def MainLoop(self): """\ - STILL UNDOCUMENTED + Start the main loop of this application. """ try: -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2goclient.git