Difference between revisions of "PyOGP Client Library Development"

From Second Life Wiki
Jump to navigation Jump to search
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is the Development page for the [[Pyogp]] [[Pyogp/Client_Lib | Client Library]].
{{PyOGP/navigation}}
If you want to work with us on pyogp here is all you need to know.
 
'''Note:''' Major revisions are needed to pull this document up to speed.
 
This is the development page for the [[Pyogp]] [[Pyogp/Client_Lib | Client Library]].
If you want to work with us on PyOGP here is all you need to know.


== Setup and Preliminary Info==  
== Setup and Preliminary Info==  
Line 6: Line 10:
* [[Pyogp/Client_Lib/The_Development_Sandbox| How to setup a development sandbox for developing the library]]
* [[Pyogp/Client_Lib/The_Development_Sandbox| How to setup a development sandbox for developing the library]]
* [[Pyogp/Client_Lib/Filesystem_Structure| The filesystem structure of pyogp]]
* [[Pyogp/Client_Lib/Filesystem_Structure| The filesystem structure of pyogp]]
* [[Pyogp/Client_Lib/Development/Design | Design]] - this is our page that outlines the draft design of the client library
* [[Pyogp/Client_Lib/Development/Zope | Zope]] - an attempt to explain how to use Zope Component Architecture, ZCA, which is used in the library
**  [http://regebro.wordpress.com/2007/11/16/a-python-component-architecture/ Read this first.] - an extremely simple intro to the ZCA


== Development Principles ==
== Development Principles ==


* Tools we use (Zope Component Architecture, buildout, eggs, unit tests)
* Tools we use (buildout, eggs, unit tests)
* Using Adapters and Utilities
* How do I add new functionality the best way? See [[PyOGP_Client_Library]] for implementation details.
* How do I add new functionality the best way?


== How-Tos ==
== How-Tos ==


* [[Pyogp/Client_Lib/newcomponent | How do I add a new component/subproject to the project?]]
* [[PyOGP_Client_Library#Extending_Functionality | How do I add a new component/subproject to the project?]]
* [[Pyogp/Client_Lib/testing | How do I write and run tests? ]]
* [[PyOGP_Package_Unittests | How do I write and run library unit tests? ]]


== Code Status ==
== Code Status ==
*[https://svn.secondlife.com/svn/linden/projects/2008/pyogp/ Current Pyogp Repo] - svn repo of the most up-to-date code we are using for the project
*[https://svn.secondlife.com/svn/linden/projects/2008/pyogp/ Current Pyogp Repo] - svn repo of the most up-to-date code we are using for the project


== Development Tasks ==
== Coding Guidelines ==
Task list for the client library. These may get PJIRA tasks someday, or some other format we decide upon.
#Start looking over and learning [[Eventlet]] most of the other documentation listed on this page
#Decide whether to [http://docs.python.org/lib/module-doctest.html doctest] or not to doctest. We are certainly planning to use [http://docs.python.org/lib/module-unittest.html unittest]
#Develop requirements specification - let's first get an idea of what it is, exactly, that we want to build
#*Requirements
#*[[Use_Cases#Limited_Capability_Clients|Use Cases]] - these might help to identify how the lib might be used by someone. We should look at these and determine which of the use cases we want to implement.
#*Identify target audience and the corresponding limitations - this project is not meant solely for Linden Lab, so we should identify who could use it and how they may use it
#Design the structure of the code according to the spec
#*Taking into consideration some of the following:
#**Must work for both Legacy and OGP (any Login or other protocols must be interfaced so to be implemented by Legacy or OGP)
#**Flexibility to allow different ways to communicate between the client and server (e.g. either eventlet, urllib2, etc.)
#Implement the design
#*Determine how to distribute the code so nobody's toes hurt and no elbows bumped


Tasks that have been recently completed:
We've recently published goals to keep in mind while writing new code for PyOGP. Please follow [[PyOGP_Coding_Guidelines]] when possible.
#*Determine whether to [http://www.muthukadan.net/docs/zca.html ZCA] or not to ZCA - ZCA enables flexibility via modularity with a component based framework. The intent would be to incorporate this into the library, while the test harness bits would remain 'stock' python. Tao Takashi will extend his initial attempt at this one for AWG and LL to review early next week.
#*Decide whether or not to incorporate [http://pypi.python.org/pypi/zc.buildout/1.0.0b30 buildout]


== Documentation ==
== Documentation ==
Line 47: Line 32:
** [[Pyogp/Client_Lib/Packet]] - notes that may help understand the rest
** [[Pyogp/Client_Lib/Packet]] - notes that may help understand the rest
** [[Pyogp/Documentation/Specification/pyogp.lib.base]] - documentation on the code
** [[Pyogp/Documentation/Specification/pyogp.lib.base]] - documentation on the code
** [[Pyogp/Client_Lib/Protocols_Explained | Protocols_Explained]] - here's a listing of the protocols that we may implement, and the implementation details about them as well.
<br>
<br>
* Current Protocols
* Current Protocols
Line 53: Line 37:
** [[Current_Sim_Capabilities]] - capabilities that are currently used
** [[Current_Sim_Capabilities]] - capabilities that are currently used
* OGP Protocols
* OGP Protocols
** [[AWG_Test_Harness_Intro]]
** [[Structural_Design]] - the design of the new architecture
** [[Structural_Design]] - the design of the new architecture
** [[Open Grid Protocol]] - the outline of the OGP protocols
** [[Open Grid Protocol]] - the outline of the OGP protocols
Line 117: Line 100:


[[Category: Pyogp_Client_Lib]]
[[Category: Pyogp_Client_Lib]]
[[Category:Pyogp_Kitchen_Sink]]

Latest revision as of 10:45, 25 June 2010

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

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

Code Status

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


  • 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>