Incorporate broder's comments.
[invirt/packages/python-afs.git] / README
1 ================
2 Installing PyAFS
3 ================
4
5 To install PyAFS, you will first need to install Cython_. It's always
6 a good idea to install Cython through your package manager, if
7 possible. Your system's Cython package may be named ``cython`` or
8 ``cython-py25``. If your package manager doesn't have a package for
9 Cython, or if you wish to install Cython by hand anyway, you can do so
10 by running::
11
12   $ easy_install Cython
13
14 Once you've done that, to install PyAFS globally, run::
15
16   $ python setup.py install
17
18 If you want to build PyAFS without installing it globally, you may
19 want to run::
20
21   $ python setup.py build_ext --inplace
22
23 which will build the C extensions in place next to their source,
24 allowing you to import the various modules, so long as your current
25 working directory is the root of the PyAFS source tree.
26
27 .. _Cython: http://cython.org/