Installing Python Fat Cookie Library

Note

You will first need to get the UTEID PEM file contact the Web Technologies Team for more information or to get the mod_auth_eid module.

Dependencies

• Python 2.4 or greater, preferably 2.5 http://www.python.org/
• OpenSSL 0.98 or greater, http://www.openssl.org/
• M2Crypto 0.9 or greater, http://chandlerproject.org/Projects/MeTooCrypto

Requirements to build the documentation:

• Sphinx 0.4 or greater http://sphinx.pocoo.org/
• Jinja 1.1 or greater http://jinja.pocoo.org/1/
• Docutils 0.4 or greater http://docutils.sourceforge.net/
• Pygments 0.8 or greater http://pygments.org/

Refer to the Building the Fat Cookie Library Documentation for more information.

Install M2Crypto Library

Linux and Mac

Check to see if OpenSSL is installed on your machine:

$ which openssl
/usr/bin/openssl

Install Openssl (on ubuntu):

$ sudo apt-get install openssl

Download the M2Crypto Library and install with the commands:

$ tar -xvzf m2crypto-0.18.2.tar.gz
$ cd m2crypto-0.18.2
$ sudo python setup.py install

Windows

On windows simply use the contributed builds which are built with the OpenSSL libraries. Simply download the exe file and run it to install M2Crypto and the required OpenSSL libraries. Make sure you use the one that matches your version of python (2.4 or 2.5).

Download the Python Fat Cookie Library

Download the tar ball with all of the source packaged for the latest release or alternatively if you are on windows just download the executable and run it:

• pycookie-1.1.tar.gz Platform independant

For the source distribution (tar.gz) use the following command to install the library:

$ tar -xvzf pycookie-1.0_pre.tar.gz
$ cd pycookie-1.0_pre
$ sudo python setup.py install

For Developers

If you are interested in seeing the source or to help develop use subversion to download the latest release:

$ svn co https://utforge.its.utexas.edu/repos/PythonFatCookie/trunk python-eid

That will create a directory called python-eid which contains the source for the Library. But you can change that to whatever you’d like.

To install the library automatically with python from a command prompt run:

$ cd python-eid
$ sudo python setup.py install

Manually on *nix

Alternatively you can manually install the library anywhere on python path. Usually the common place is the site-packages directory, but it could be in your home directory if you do not have sudo access.

Installing in site-packages (commonly /usr/lib/pythonX.X/site-packages/ adjust as needed):

$ cd python-eid
$ sudo ln -s pycookie /usr/lib/python2.5/site-packages

Or install in your home directory (just add the library to your PYTHONPATH)

For bash shell edit your .profile or .bash_profile and add lines:

PYTHONPATH=$PYTHONPATH:(path to python-eid)/pycookie/
export PYTHONPATH

For csh tcsh edit your .cshrc file and add lines:

setenv PYTHONPATH $PYTHONPATH:(path to python-eid)/pycookie/

Now What?

Now that you have pycookie installed you can verify that it was successful by importing on a python shell:

$ python
Python 2.5.1 (r251:54863, Feb  4 2008, 21:48:13)
[GCC 4.0.1 (Apple Inc. build 5465)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import pycookie

If you don’t get an error you are all set for more information please refer to the Getting Started with the Python Fat Cookie Library documentation.