PyOGP Client Library Development

Note: Major revisions are needed to pull this document up to speed.

This is the development page for the Pyogp Client Library. If you want to work with us on PyOGP here is all you need to know.

Setup and Preliminary Info

• How to setup a development sandbox for developing the library
• The filesystem structure of pyogp

Development Principles

• Tools we use (buildout, eggs, unit tests)
• How do I add new functionality the best way? See PyOGP_Client_Library for implementation details.

How-Tos

• How do I add a new component/subproject to the project?
• How do I write and run library unit tests?

Code Status

• Current Pyogp Repo - svn repo of the most up-to-date code we are using for the project

Coding Guidelines

We've recently published goals to keep in mind while writing new code for PyOGP. Please follow PyOGP_Coding_Guidelines when possible.

Documentation

• Pyogp created documentation
  • Pyogp/Client_Lib/Packet - notes that may help understand the rest
  • Pyogp/Documentation/Specification/pyogp.lib.base - documentation on the code

• Current Protocols
  • Current_login_protocols - what login is like now
  • Current_Sim_Capabilities - capabilities that are currently used
• OGP Protocols
  • Structural_Design - the design of the new architecture
  • Open Grid Protocol - the outline of the OGP protocols
  • OGP Draft Login flowchart - flowchart for current OGP login protocols
  • SLGOGP_Teleport_Strawman - what login may be like
  • Second_Life_Login_API_Strawman - what login may be like
  • OGP_Draft_Login - diagrams of the OGP login
• General Notes
  • Second_Life_Grid_Protocols/Foundation - general protocol information
  • Protocol - this is general information about messaging and the various protocol systems
  • COMET programming
  • Eventlet - a networking library written in Python, probably going to be used for this project
    • NOTE: We have been testing eventlet and it seems there's a problem posting to the seed capability.
      • Pyogp_Client_Lib/Login_Test_Script - a very simple test script using eventlet that fails at the post to the seed cap
    • Windows Instructions - Eventlet for Windows is a bit tricky to install
      • User:Baba_Yamamoto/Eventlet - there are some problems with eventlet that Baba has looked into
      • greenlet - you MUST have Visual Studio 2003 installed to install greenlet on windows (are there binary versions?). Use easy_install greenlet to install it.
      • pyOpenSSl - windows versions
        • pyOpenSSL py2.4 - windows pyOpenSSL for Python 2.4
        • pyOpenSSL py2.5 - windows pyOpenSSL for Python 2.5
      • util.py - has a dependency on fcntl. Go into eventlet's util.py, and either comment out all the fcntl calls, or for a slightly (not a good fix) better solution, Donovan's Fix
  • Circuit - the way to pass two-way information along a UDP connection
  • Message - more detail of messages
  • Reverse_HTTP - I believe this is used (or will be) in the OGP protocols
  • General Packet Format - libsecondlife - describes what the general format is for a packet
  • ACKs - libsecondlife - describes what an ACK is
• Coding notes
  • ZCA Guide - ZCA that the lib project will be using
• Python Docs
  • DistUtils -
    • Sig for utils
  • Python Eggs -
    • setuptools - lib to handle eggs

• Old Code
  • Tao Takashi's Pyogp - svn repo - Tao Takashi has hit the ground running with an experimental framework which has been made available here.
    • Read more at his blogpost describing the start of his work at his very long url.
  • Sai's Presence and Sai's Presence_cmd_line - Saijanai Kuhn's first attempts at some Python presence
  • Linden Pyogp - svn repo of Linden's first stab at framework, using Sai's code as a base
    • pyogp.lib-login.py - sample script which logs into aditi's agent domain and establishes a presence on a simulator on vaak:
    • Disclaimer*: Everything in the repo now will change dramatically in the next few weeks as things firm up structure wise. My desires for the work include: a simple, well defined library, a separate test framework (unittest, the initial high level code to be added this week), an samples/examples sandbox, and clean well commented code. That said, none of the above are in place now. They will be. More sophisticated implementations can evolve over time, or can be included on the side of the library...
  • Example_protocol_code - code written about login and presence
  • Interop Ruths - some news that may be of interest to us

Licensing

1. The code written as part of this effort is subject to the Apache v2 license. Read more at http://opensource.org/licenses/apache2.0.php.

 <excerpt>
 Copyright 2008, Linden Research, Inc.
 

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 

 http://www.apache.org/licenses/LICENSE-2.0
 

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 </excerpt>