Home | History | Annotate | Download | only in docs
      1 Installing Python-Markdown
      2 ==========================
      3 
      4 Checking Dependencies
      5 ---------------------
      6 
      7 Python-Markdown requires the ElementTree module to be installed. In Python2.5+ 
      8 ElementTree is included as part of the standard library. For earlier versions 
      9 of Python, open a Python shell and type the following:
     10 
     11     >>> import cElementTree
     12     >>> import ElementTree
     13 
     14 If at least one of those does not generate any errors, then you have a working
     15 copy of ElementTree installed on your system. As cElementTree is faster, you
     16 may want to install that if you don't already have it and it's available for 
     17 your system.
     18 
     19 See <http://effbot.org/zone/element-index.htm> for more information or to 
     20 download the latest version of ElementTree.
     21 
     22 The East Way
     23 ------------
     24 
     25 The simplest way to install Python-Markdown is by using SetupTools. As and
     26 Admin/Root user on your system do:
     27 
     28     easy_install ElementTree
     29     easy_install Markdown
     30 
     31 That's it, your done.
     32 
     33 Installing on Windows
     34 ---------------------
     35 
     36 Download the Windows installer (.exe) from PyPI: 
     37 <http://pypi.python.org/pypi/Markdown>
     38 
     39 Double-click the file and follow the instructions.
     40 
     41 If you prefer to manually install Python-Markdown in Windows, download the
     42 Zip file, unzip it, and on the command line in the directory you unzipped to:
     43 
     44     python setup.py install
     45 
     46 If you plan to use the provided command line script, you need to make sure your
     47 script directory is on your system path. On a typical Python install of Windows
     48 the Scripts directory is `C:\Python25\Scripts\`. Adjust according to your 
     49 system and add that to your system path.
     50 
     51 Installing on *nix Systems
     52 --------------------------
     53 
     54 From the command line do the following:
     55 
     56     wget http://pypi.python.org/packages/source/M/Markdown/Markdown-2.0.tar.gz
     57     tar xvzf Markdown-2.0.tar.gz
     58     cd markdown-2.0/
     59     sudo python setup.py install
     60 
     61 Using the Git Repository
     62 ------------------------
     63 
     64 If your the type that like to live on the edge, you may want to keep up with 
     65 the latest additions and bug fixes in the repository between releases.
     66 Python-Markdown is maintained in a Git repository on Gitorious.org. To
     67 get a copy of Python-Markdown from the repository do the following from the
     68 command line:
     69 
     70     git clone git://gitorious.org/python-markdown/mainline.git python-markdown
     71     cd python-markdown
     72     python setup.py install
     73 
     74