"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "docs/users_guide/gettingStarted.rst" between
cheetah3-3.1.0.tar.gz and cheetah3-3.2.0.tar.gz

About: Cheetah3 is a template engine and code generation tool for e.g. for Web development or Java, SQL, LaTeX, form email ... (written in Python).

gettingStarted.rst  (cheetah3-3.1.0):gettingStarted.rst  (cheetah3-3.2.0)
Getting Started Getting Started
=============== ===============
(gettingStarted)
Requirements Requirements
------------ ------------
(gettingStarted.requirements)
Cheetah requires Python release 2.7 (there are plans to support 3.4+). Cheetah requires Python release 2.7 (there are plans to support 3.4+).
It is known to run on Linux, Windows, FreeBSD and Solaris, It is known to run on Linux, Windows, FreeBSD and Solaris,
and should run anywhere Python runs. and should run anywhere Python runs.
99% of Cheetah is written in Python. There is one small C module 99% of Cheetah is written in Python. There is one small C module
({\_namemapper.so}) for speed, but Cheetah automatically falls back ({\_namemapper.so}) for speed, but Cheetah automatically falls back
to a Python equivalent ({NameMapper.py}) if the C module is not to a Python equivalent ({NameMapper.py}) if the C module is not
available. available.
Cheetah can use an additional module Markdown but it's not strictly required. Cheetah can use an additional module Markdown but it's not strictly required.
Installation Installation
------------ ------------
(gettingStarted.install)
To install Cheetah in your system-wide Python library: To install Cheetah in your system-wide Python library:
#. Login as a user with privileges to install system-wide Python #. Login as a user with privileges to install system-wide Python
packages. On POSIX systems (AIX, Solaris, Linux, IRIX, etc.), the packages. On POSIX systems (AIX, Solaris, Linux, IRIX, etc.), the
command is normally 'su root'. On non-POSIX systems such as Windows command is normally 'su root'. On non-POSIX systems such as Windows
NT, login as an administrator. NT, login as an administrator.
#. Run {pip install Cheetah3} at the command prompt. #. Run {pip install Cheetah3} at the command prompt.
#. Or download source code and run {python setup.py install}. #. Or download source code and run {python setup.py install}.
skipping to change at line 65 skipping to change at line 59
python setup.py install --home /home/tavis python setup.py install --home /home/tavis
python setup.py install --install-lib /home/tavis/lib/python python setup.py install --install-lib /home/tavis/lib/python
Either way installs to /home/tavis/lib/python/Cheetah/ . Of course, Either way installs to /home/tavis/lib/python/Cheetah/ . Of course,
/home/tavis/lib/python must be in your Python path in order for /home/tavis/lib/python must be in your Python path in order for
Python to find Cheetah. Python to find Cheetah.
Files Files
----- -----
(gettingstarted.files)
If you do the systemwide install, all Cheetah modules are installed If you do the systemwide install, all Cheetah modules are installed
in the { site-packages/Cheetah/} subdirectory of your standard in the { site-packages/Cheetah/} subdirectory of your standard
library directory; e.g., library directory; e.g.,
/opt/Python2.2/lib/python2.2/site-packages/Cheetah. /opt/Python2.2/lib/python2.2/site-packages/Cheetah.
Two commands are installed in Python's {bin/} directory or a system Two commands are installed in Python's {bin/} directory or a system
bin directory: {cheetah} (section gettingStarted.cheetah) and bin directory: {cheetah} (section gettingStarted.cheetah) and
{cheetah-compile} (section howWorks.cheetah-compile). {cheetah-compile} (section howWorks.cheetah-compile).
Uninstalling Uninstalling
------------ ------------
(gettingstarted.uninstalling)
To uninstall Cheetah, merely delete the site-packages/Cheetah/ To uninstall Cheetah, merely delete the site-packages/Cheetah/
directory. Then delete the "cheetah" and "cheetah-compile" commands directory. Then delete the "cheetah" and "cheetah-compile" commands
from whichever bin/ directory they were put in. from whichever bin/ directory they were put in.
The 'cheetah' command The 'cheetah' command
--------------------- ---------------------
(gettingStarted.cheetah)
Cheetah comes with a utility {cheetah} that provides a command-line Cheetah comes with a utility {cheetah} that provides a command-line
interface to various housekeeping tasks. The command's first interface to various housekeeping tasks. The command's first
argument is the name of the task. The following commands are argument is the name of the task. The following commands are
currently supported: currently supported:
:: ::
cheetah compile [options] [FILES ...] : Compile template definitions cheetah compile [options] [FILES ...] : Compile template definitions
cheetah fill [options] [FILES ...] : Fill template definitions cheetah fill [options] [FILES ...] : Fill template definitions
cheetah help : Print this help message cheetah help : Print this help message
skipping to change at line 117 skipping to change at line 105
The test suite is described in the next section. The {compile} The test suite is described in the next section. The {compile}
command will be described in section howWorks.cheetah-compile, and command will be described in section howWorks.cheetah-compile, and
the {fill} command in section howWorks.cheetah-fill. the {fill} command in section howWorks.cheetah-fill.
The depreciated {cheetah-compile} program does the same thing as The depreciated {cheetah-compile} program does the same thing as
{cheetah compile}. {cheetah compile}.
Testing your installation Testing your installation
------------------------- -------------------------
(gettingStarted.test)
After installing Cheetah, you can run its self-test routine to After installing Cheetah, you can run its self-test routine to
verify it's working properly on your system. Change directory to verify it's working properly on your system. Change directory to
any directory you have write permission in (the tests write any directory you have write permission in (the tests write
temporary files). Do not run the tests in the directory you temporary files). Do not run the tests in the directory you
installed Cheetah from, or you'll get unnecessary errors. Type the installed Cheetah from, or you'll get unnecessary errors. Type the
following at the command prompt: following at the command prompt:
:: ::
cheetah test cheetah test
skipping to change at line 169 skipping to change at line 155
#. your version of Python #. your version of Python
#. your operating system #. your operating system
#. whether you have changed anything in the Cheetah installation #. whether you have changed anything in the Cheetah installation
Quickstart tutorial Quickstart tutorial
------------------- -------------------
(gettingStarted.tutorial)
This tutorial briefly introduces how to use Cheetah from the Python This tutorial briefly introduces how to use Cheetah from the Python
prompt. The following chapters will discuss other ways to use prompt. The following chapters will discuss other ways to use
templates and more of Cheetah's features. templates and more of Cheetah's features.
The core of Cheetah is the {Template} class in the The core of Cheetah is the {Template} class in the
{Cheetah.Template} module. The following example shows how to use {Cheetah.Template} module. The following example shows how to use
the {Template} class in an interactive Python session. {t} is the the {Template} class in an interactive Python session. {t} is the
Template instance. Lines prefixed with {>>>} and {...} are user Template instance. Lines prefixed with {>>>} and {...} are user
input. The remaining lines are Python output. input. The remaining lines are Python output.
 End of changes. 8 change blocks. 
16 lines changed or deleted 0 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)