Source

blaag / INSTALL.txt

How to install blaag
====================

To test Blaag, you can simply unpack blaag, and then run it in the 
folder example_blaag using::

  $ python ../blaag.py

but you'll need to make sure some Python libraries are available as
requirements:

* docutils

* hgapi

* PyRSS2Gen

You can also install Blaag by running::

  $ python setup.py install
  
in your blaag folder; this will install the 'blaag' script in your 
Python installation's script folder.

To create your own blaag, copy or clone example_blaag, add entries 
in the '/entries' subfolder, and run blaag to generate html (in a 
subfolder named '/html'). To configure the Blaag, modify blaag.cfg
and/or HTML fragments in the '/custom' folder

You could do that using pip or easy_install. You can also use the
buildout installation below, which provides a few more goodies.

buildout installation
---------------------

To automatically install all dependencies and a few other tools
locally in the project, you can use buildout. First you need to
install buildout using the bootstrap::

  $ python bootstrap.py -d

(the ``-d`` argument uses distribute instead of setuptools, so you can
leave it off)

Now you can run buildout::

  $ bin/buildout -N

(the ``-N`` arguments avoids loading dependencies from PyPI if a
version is already there. you can leave it off too but it'll be a bit
slower the next time you run it)

This will automatically install the dependencies. Now you can run ``blaag``
like this::

  $ bin/blaag

There's also a ``bin/devpython``::

  $ bin/devpython

``bin/devpython`` is a Python interpreter wrapper that has the
``blaag`` dependencies installed so they can be imported, along with
``blaag`` itself. So you could do this too::

  $ bin/devpython blaag.py

As a bonus you get ``pyflakes`` installed so you can clean up the
``blaag`` source code with it.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.