PyOGP Client Library

Introduction

The Python OGP Client Library, also known as pyogp consists of several parts in a pyogp.* namespace. These are:

- pyogp.lib.base (the base library) - pyogp.lib.agentdomain (support functionality for agent domain specific modules)

Overview

- How to use pyogp.lib.base (coming later, once it is usable) - How to setup a development sandbox to help developing pyogp.lib.base - Architecture of the client library

Status

This page is dedicated to the client library aspect of the Pyogp project. The more general page is Pyogp.
Please visit the Development page for more technical details. This page is meant to be an overview for our end-users.

Overview

The longer term vision of the Pyogp project is essentially to create 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... In the long, long run, the Client lib could be used as the basis for a lightweight client written in Python.

Objectives

On the wiki page Protocol, there is a list of all the protocols that SL currently uses. We plan on implementing any and every protocol we can. We want the client library to have as much functionality as possible, keeping in mind that it is lightweight. However, we would like to prioritize the features we implement. Pyogp should be a client for both the Legacy protocols and OGP protocols, as they become implemented. Currently, the priority list is:

1. Login
2. Establish/maintain presence
3. Parse the data sent via the communication channels (event queue/UDP)
4. Start building out functionality in the client

It seems there is some desire to have the client be usable from a command line for such things as IM, checking friends online, viewing inventory, etc.

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>