amaGama documentation¶

Dependencies¶

amaGama requires the following dependencies:

• Python 2: 2.6 or later.
• PostgreSQL: Tested on 8.3 and 8.4.

There are also some dependencies that we strongly recommend to use, but are optional:

• git: Necessary to get amaGama.
• virtualenv: Provides an isolated environment or virtualenv.
• virtualenvwrapper: To ease handling virtualenvs.

Consult the specifics for your operating system in order to get each above package installed successfully.

Setting up a virtualenv¶

The use of virtualenvs allows to install all the requirements at specific versions without interfering with system-wide packages. To create a virtualenv just run:

$ mkvirtualenv amagama

Getting amaGama¶

There is no package for amaGama, so you will need to run it from a git checkout:

(amagama) $ git clone https://github.com/translate/amagama.git
(amagama) $ cd amagama

Installing the requirements¶

Then install the requirements:

(amagama) $ pip install -r requirements/recommended.txt

After installing the amaGama requirements, you can safely start amaGama installation.

Creating the database¶

amaGama requires a PostgreSQL database to store translations. So create an empty database, for example doing the following:

$ su root
# su postgres
$ createdb -E UTF-8 amagama

createdb: database creation failed: ERROR: new encoding (UTF8) is
incompatible with the encoding of the template database (SQL_ASCII)

$ createdb -E UTF-8 -T template0 amagama

Adjusting the settings¶

The next step is to adjust amaGama settings to include the right database connection configuration, and perhaps change any other setting. Check the amaGama settings documentation in order to know how to do it.

DB_HOST = "localhost"

Making the commands accessible¶

Since amaGama is not installed we need to make accessible its commands:

$ export PATH=$(pwd)/bin:$PATH
$ export PYTHONPATH=$(pwd):$PYTHONPATH

Preparing the database¶

The first step after editing the settings is to prepare database tables for each source language you will use (you can add more languages later):

$ amagama-manage initdb -s en -s fr

Next steps¶

Now that you have managed to install amaGama you will probably want to know how to:

• Manage amaGama
• Import translations to amaGama
• Run amaGama

Global settings¶

Settings to define amaGama server behavior.

DEBUG

Default: False

Indicates if the debug mode is enabled.

SECRET_KEY

Default: foobar

Indicates the secret key to use for keeping the sessions secure.

ENABLE_WEB_UI

Default: False

Indicates if the web interface is enabled.

ENABLE_DATA_ALTERING_API

Default: False

Indicates if the part of the amaGama API that allows data to be altered is enabled.

This doesn’t affect to the part of the API that is used to perform queries that don’t alter the data. For example retrieving translations is always enabled.

Database settings¶

Settings used for connecting to the amaGama database.

DB_HOST

Default: "localhost"

Hostname of the server where the amaGama database is located.

DB_NAME

Default: "amagama"

amaGama database name.

DB_PASSWORD

Default: ""

Password for the amaGama database user.

DB_PORT

Default: "5432"

Port number where the database server holding the amaGama database is listening.

DB_USER

Default: "postgres"

User name for connecting to the amaGama database.

Database pool settings¶

Settings for the database pool.

DB_MAX_CONNECTIONS

Default: 20

Maximum number of connections that the pool database will handle.

DB_MIN_CONNECTIONS

Default: 2

Number of connections to the database server that are created automatically in the database pool.

Levenshtein settings¶

Settings for Levenshtein algorithm. See Levenshtein distance for more information.

MAX_CANDIDATES

Default: 5

The maximum number of results returned. This can be overridden by providing another value using a query string.

MAX_LENGTH

Default: 1000

Maximum length of the string. If the string length is higher then it won’t be matched neither returned in the results.

MIN_SIMILARITY

Default: 70

The minimum similarity between the string to be searched and the strings to match.

This can be overridden by providing another value using a query string, but there is a hardcoded minimum possible value of 30. If a lower value is provided then 30 will be used.

Available subcommands¶

These are the available management subcommands for amaGama:

$ amagama-manage deploy_db
This will permanently alter the database. Continue? [n] y
Succesfully altered the database for deployment.

$ amagama-manage dropdb -s fr -s de
This will permanently destroy all data in the configured database. Continue? [n] y
Succesfully dropped the database for 'fr', 'de'.

$ amagama-manage initdb -s en -s fr
Succesfully initialized the database for 'en', 'fr'.

$ amagama-manage tmdb_stats
Complete database (amagama):        400 MB
Complete size of sources_en:        234 MB
Complete size of targets_en:        160 MB
sources_en (table only):    85 MB
targets_en (table only):    66 MB
sources_en  sources_en_text_idx     83 MB
targets_en  targets_en_unique_idx   79 MB
sources_en  sources_en_text_unique_idx      53 MB
targets_en  targets_en_pkey 16 MB
sources_en  sources_en_pkey 13 MB