README.txt

   1 NOTE: This library is still in ALPHA.
   2
   3
   4 Getting started
   5 ===============
   6 The examples use bash/zsh shell compatible commands.
   7
   8
   9 Requirements
  10 ------------
  11
  12 If you want all the tests to pass install "lxml", "pysqlite",
  13 and "setuptools". You do not need "pysqlite" if you use python2.5.
  14
  15
  16 Run the testsuite
  17 -----------------
  18
  19 Run the tests using (all should pass):
  20         ~$ python setup.py test
  21 You can use:
  22         ~$ make clean
  23 to remove the temporary files.
  24
  25
  26 Build the apidocs
  27 -----------------
  28
  29 Install ">=epydoc-3". And run:
  30         ~$ make doc
  31 If everything works you should be able to browse the docs by
  32 pointing your browser to:
  33         ~$ apidoc/index.html
  34
  35
  36 Install the library in development mode
  37 ---------------------------------------
  38
  39 Setuptools can be used to install the library in development mode.
  40 This actually just makes a link, so you can still use git without
  41 having to reinstall.
  42
  43 Lets use ~/devpy as our install folder:
  44         ~$ mkdir ~/devpy
  45         ~$ export PYTHONPATH="$PYTHONPATH:$HOME/devpy"
  46         ~$ export PATH="$PATH:$HOME/devpy"
  47         ~$ python setup.py develop -d ~/devpy
  48 You should of course add the exports to your .bashrc/.zshrc or
  49 similar.
  50
  51 You can test the install like this:
  52         ~$ cd
  53         ~$ python -c "import enkel"