==========
Pycabulary
==========

:Author: Marco Giusti marco.giusti@gmail.com
:Date: 2010-02-07
:Copyright: public domain
:Version: 1
:Manual section: 1


DESCRIPTION
===========

Pycabulary_ is a parser for dicius_ implemented in Python_.

dicius_ is a free online language dicionaries and Pycabulary_ offer a
confortable interface to it. Actually Pycabulary_ is, at the moment,
three different interfaces for the same service, a command line
interface, GTK_ one and a Tkinter_ one, chooce what the best is for you.
Notice that Tkinter_ is part of the standard Python_ library and is
fully portable to every platform Python_ is supported (MasOs, Windows
and Unix).

At the moment only english/italian and italian/english vocabularies are
implemented.


INSTALL
=======

Pycabulary_ uses setuptools_ and pypi_ so procedure should be painless.

With `easy_install`::

    easy_install pycabulary

or `download the tarball from pypi <http://pypi.python.org/Pycabulary/>`_,
unpack it and install it::

    tar zxf Pycabulary-1.0.tar.gz
    cd Pycabulary-1.0/
    python setup.py install

If you prefer download the last source from bitbucket_::

    hg clone http://bitbucket.org/gm/pycabulary/


USAGE
=====

To translate to english from italian on terminal::

    pycabulary cli -e vocabolario

For more info::

    pycabulary --help

To run the GTK_ version or the Tkinter_ version::

    pycabulary gtk

or::

    pycabulary tk

I did not tried it on Windows but at least a double click on the
executable should be enough to run the Tkinter_ version. Also the .egg
file should be executable, or *eggsecutable*, try a double click on it.


DOCS
====

For the docs look in the ``docs/`` directory. To build the man page
install ``docutils`` and ``rst2man`` and type from the console::

    rst2man pycabulary.txt pycabulary.1



.. _Pycabulary: http://
.. _dicius: http://it.dicios.com/
.. _GTK: http://pygtk.org/
.. _Tkinter: http://wiki.python.org/moin/TkInter
.. _Python: http://www.python.org/
.. _bitbucket: http://bitbucket.org/
.. _pypi: http://pypi.python.org/
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools

.. vim: set ft=rst tw=72 :

