PyOGP

Overview

What is it?

Linden Lab and its community based AWG (in-world discussion group page) are working together to develop a set of open protocols (called the Open Grid Protocol (OGP)) that can be used to create a virtual world where regions are independently operated (not only by Linden Lab). The project is aiming to allow people (organizations, individuals, and the like) to host their own regions in the virtual world and be able to interact and communicate with people in regions hosted elsewhere. In essence, the project's goal is to allow open-source region hosting.

AWG and Linden Lab plan to share the effort in writing a test harness which executes tests against implementations of the Open Grid Protocol. The intent is not to test SL or OpenSim (or gridX) themselves. Rather, the desire is to create a framework where the implementations of the protocols can be tested in any virtual environment implemented per the Open Grid Protocols as documented. The goal is to use the test harness to test the implementations to make sure that the virtual environment is interoperable with the other virtual environments that have implemented the OGP. However, we also plan to test the current SL protocols (the Legacy protocols). We plan to be able to test at the smallest functional level possible, akin to unit testing, and to have the ability to use the framework to sequence steps to enable state specific tests to be run.

The longer term vision is essentially a client library, capable of navigating the grid and interacting with the various hosts, sitting next to a testing framework, happily running along telling us what works where, and where something needs a little attention to work according to specification...

For a smidge more detail on OGP, see a visual representation of the upcoming projects and a general introduction.

What does it consist of?

Pyogp is actually an umbrella name that consists of a group of efforts. The project is currently broken into two parts: the Python client library and test harness. We imagine that in the future there will be more components to the Pyogp project.

• Pyogp/Client_Lib - a library that can be used to mimic a client so as to interact with the grid. It may someday be used for automated testing or even as the basis for a light-weight client written in Python.
• Pyogp/Test_Harness - the protocol implementation testing framework. It will also be used to test the client library.

Project Status

• June 26, 2008 - We have begun to write some code to prototype the client library framework. We have also discussed some of the details of the client lib and how we should begin to structure it.

Project Tasks

These are tasks that need to be accomplished for the overall project. Each part of the project (library and harness) also has its own task list.

1. To do:
   • commit rights
   • expand on the roadmap
   • task list
   • test framework and documentation

1. Set up collaboration methods
   • Meeting Times - Enus is out of the Linden Lab office until July 14th. June 28th is unavailable for him, the following week is some silly American holiday, and the following Friday (July 11) is a travel day). July 18th will be the first sc heduled office hours where Pyogp will be a primary topic.
   • Mailing list - should probably set this up as a Linden hosted list...
2. Start planning structure for Pyogp overall (see Pyogp/Specification), with an initial emphasis on the client library.
   • ZCA, buildout and eggs have been tapped as components/attributes of Pyogp...
3. Start planning structure for test harness (see Pyogp/Test_Framework)

Recently completed tasks include:

1. (complete?)License - The Apache V2 License has been selected as the license of choice for pyogp (or whatever name we agree upon, see next point).
2. (complete?)Naming (I'd like to not debate for an hour on these. Tao had suggestions, I like em. Please speak up if you have strong reservations about the suggested naming).
   • Python client library name - pyogp
   • Python test framework (unittest/doctest) - ?
3. (complete?)Repository - So Mercurial, aka hg, was looking promising, but we decided internally that we aren't quite ready for that. There is a move toward Mercurial internally, but we need to work this out before moving forward with it on this effort. It is quite possible that this library and test harness work will become a guinea pig for hg with Linden Lab in the open source arena. Until then, I bring you pyogp on SVN: http://svn.secondlife.com/trac/linden/browser/projects/2008/pyogp.
4. (complete?)Contributions - As we are going to be hosting the source code for this, contributions will be subject to Linden Lab's standard contributor's agreement. I hope this doesn't prevent good work here...

Collaboration

Communication Channels

• Communication
  • IRC: irc://irc.freenode.com/#pyogp
  • mailing list: TBD
  • AW_Groupies - AWG in-world discussion group, Pyogp is occassionally covered at the Tuesday morning meetings at 9:30 SLT
  • In-world meeting: Fridays, 1:00PM SLT. This is starting July 11.
    • We will post the location as soon as we decide.

Contributors

• Main Linden Lab Contributors
  • Enus -
  • Infinity -
  • Locklainn -
• Main AWG Contributors (subject to the contributor's agreement)
  • Tao Takashi -
  • Saijanai Kuhn -
  • (your name here)

Related Chat Logs

• April: AW Groupies 29 April
• May: AW Groupies 20 May · Which LInden Office Hours 22 May
• June: Zero Linden Office Hours 19 June AW Groupies 24 June Zero Linden Office Hours 24 June

Links

Please add to the list as you see fit. The more we throw in here, the better off we are in the long run.

• Python Client Library - dedicated page to the client library
• Pyogp Test Framework - dedicated page to the test harness
• Pyogp Roadmap - the overall plan for pyogp. Each dedicated page, however, has its own roadmap
• Pyogp Specification - the technical specifications and guidelines to follow when working on the code
• Internal jira tracking Linden Lab's involvement with the work: uh, I'll get back to you.
• Repository - http://svn.secondlife.com/trac/linden/browser/projects/2008/pyogp.
  • Note that the code here has changed. The new code is Tao's base code. The old code, the Linden code, is at pyogp_old.
• License - The Apache V2 License has been selected as the license of choice for pyogp.
• Pyogp Development Information - how is development being done, how do I setup my development sandbox, how do I get the code?

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>

Picture of the Moment

1. 05/29/08: Using quite nasty code, a first contact of sorts via python into the agent domain and onto a simulator:
   

   pyogp and ad enabled sl viewer on a vaak sim via aditi's agent domain