PyOGP Client Library Development Sandbox

PyOGP

• Roadmap
• PyOGP Client Library:
  • Coding Guidelines
  • Package Development
  • Client Development Sandbox
  • Package Unittests

We will first run down the general explanation and add platform specific notes later.

Repositories

Stable trunk repositories:

• http://bitbucket.org/enus_linden/pyogp.apps/
• http://bitbucket.org/enus_linden/pyogp.lib.base/
• http://bitbucket.org/enus_linden/pyogp.lib.client/
• http://bitbucket.org/enus_linden/pyogp.buildout/

Maintenance repositories:

• http://bitbucket.org/enus_linden/pyogp.apps-maint/
• http://bitbucket.org/enus_linden/pyogp.lib.base-maint/
• http://bitbucket.org/enus_linden/pyogp.lib.client-maint/
• http://bitbucket.org/enus_linden/pyogp.buildout-maint/

Defunct until someone picks them up and fixes them:

• http://bitbucket.org/enus_linden/pyogp.interop/
• http://bitbucket.org/enus_linden/pyogp.lib.agentdomain/

Browse the Code

If all you want to do is glance at the source code, use the bitbucket source browser:

• http://bitbucket.org/enus_linden/pyogp.apps/src/
• http://bitbucket.org/enus_linden/pyogp.buildout/src/
• http://bitbucket.org/enus_linden/pyogp.interop/src/
• http://bitbucket.org/enus_linden/pyogp.lib.agentdomain/src/
• http://bitbucket.org/enus_linden/pyogp.lib.base/src/
• http://bitbucket.org/enus_linden/pyogp.lib.client/src/

Environment Preparation

Prerequisites

You must have the following installed:

• Mercurial - 1.3 or greater
• Python 2.4.4, 2.5.x, 2.6.x (untested on 3.0)

Mac Specifics

Note: Snow Leopard upgrades require a reinstall of XCode, in this case to accommodate gcc (and greenlet).

Setuptools and easy_install are Python standard means for installing modules. For more info, start here: http://pypi.python.org/pypi/setuptools.

Virtualenv is a method which allows you to create isolated Python environments, separate from your base install if you so prefer. For more, see here: http://pypi.python.org/pypi/virtualenv.

Your distribution may have Python's setuptools and virtualenv packages in its package repository. If so, it is probably best to use your normal package installation procedures (see below for information on specific Linux distributions). If the packages are not available then follow these generic instructions.

Generic *nix Specifics

In order to install Python Packages and creating a development sandbox you have to do the following:

easy_install

"Easy Install is a python module (easy_install) bundled with setuptools that lets you automatically download, build, install, and manage Python packages." I stole that from here: http://peak.telecommunity.com/DevCenter/EasyInstall.

Download ez_setup.py and run it with your Python interpreter. You can find it here: http://peak.telecommunity.com/dist/ez_setup.py

Eventually you have to be root to do this depending on your system (mostly non-windows). It should look like this on a unix based machine:

wget http://peak.telecommunity.com/dist/ez_setup.py
 -or-
curl -O http://peak.telecommunity.com/dist/ez_setup.py
sudo python ez_setup.py

virtualenv

Virtualenv builds isolated python environments. To learn more, read this: http://pypi.python.org/pypi/virtualenv.

To use a dedicated python installation in your host, isolated from your system python install, install virtualenv like this:

easy_install virtualenv

Or, if you need to be root something like this:

sudo easy_install virtualenv

On windows, you may need a different path to easy_install

c:\Python25\Scripts\easy_install.exe virtualenv

Install methods

Python modules can be installed in a variety of ways... we're encouraging the virtualenv and setup.py method.

buildout

Buildout has a variety of uses, in PyOGP's case it is used as a development sandbox. Buildout will checkout all the necessary PyOGP repositories and their dependencies, and configure everything automatically (set up the right path members and install scripts). Once the sandbox is set up, you can make changes to the libs in the parts/ directory (they are actually local mercurial repositories), update the code referenced in buildout (re-run bin/buildout), and test your changes.

It's really easy to work with...

1. First check out the buildout into a directory of your choice:

hg clone http://bitbucket.org/enus_linden/pyogp.buildout (or grab pyogp.buildout-maint to work with maintenance repos)

2. Now turn this checkout into a virtual python environment, independent of your normal Python installation:

cd pyogp.buildout
virtualenv . --no-site-packages

on windows, you may need to specify the path

c:\Python25\Scripts\virtualenv.exe . --no-site-packages

3. Now run the bootstrap.py file with the newly created local Python interpreter:

bin/python bootstrap.py

or on Windows:

 Scripts\python bootstrap.py

4. This creates a bunch of directories and the bin/buildout script (bin\buildout.exe on windows). We now run this:

 bin/buildout -v

or on Windows:

 bin\buildout.exe -v

5. The development sandbox is ready. There now is a bin/pyogp_interpreter, a python interpreter which contains all the installed packages and the pyogp libraries and dependencies referenced in the path.

6. Test the buildout installation. To test this installation you can (at least at this stage of the project) try the following sample script or run the unittests:

 bin/region_connect <firstname> <lastname>

 -or-

 bin/unittests --where=parts/pyogp.lib.base (or pyogp.lib.client)

Enter the avatar's password when prompted, and you're on your way to aditi, the Beta Grid.

setup.py

If you prefer to not use buildout, and to do things a bit more manually, well, you probably don't need much help here then do you? ;)

Grab the source for each of the pyogp repos, and install them to a virtualenv instance (see above for installing virtualenv if you don't have it)..

Here's a simple setup that Enus likes:

cd ~
mkdir sandbox
cd sandbox
virtualenv . --no-site-packages
cd ~
mkdir hg
cd hg
hg clone https://enus_linden@bitbucket.org/enus_linden/pyogp.apps/
hg clone https://enus_linden@bitbucket.org/enus_linden/pyogp.lib.base/
hg clone https://enus_linden@bitbucket.org/enus_linden/pyogp.lib.client/
cd ~/hg/pyogp.lib.base
~/sandbox/bin/python setup.py install
cd ~/hg/pyogp.lib.client
~/sandbox/bin/python setup.py install
cd ~/hg/pyogp.apps
~/sandbox/bin/python setup.py install
......
now, in ~/sandbox/bin/ you'll have all kinds of pyogp executables for testing stuff out (like region_connect, etc)

You now have all the source, plus a sandbox, for tinkering with pyogp!

To try an executable out, just run it in ~/sandbox/bin/. for example:

 ~/sandbox/bin/region_connect firstname lastname

This command will login in your agent to aditi, and will prompt you for a password.

Pass any script the "-h" param to get it's usage.

Run the tests

See PyOGP_Package_Unittests for details...