GiellaLT provides an infrastructure for rule-based language technology aimed at minority and indigenous languages, and streamlines building anything from keyboards to speech technology. Read more about Why. See also How to get started and our Privacy document.
Setting up a development or testing environment goes in three major steps.
These steps are explained below. For the impatient, here comes a Summary:
neahttadigisanit is the source directory of the repositorium.
cd neahttadigisanit/neahtta/
python3 -m virtualenv -p /usr/bin/python3.9 .venv
. .venv/bin/activate
python -m pip install -e ".[dev]"
cd neahtta/
npm install
cd ..
cd neahttadigisanit/neahtta/
. .venv/bin/activate
nds dev saanih
Then to the explanation proper.
Neahttadigisánit is tested with Python 3.9. Since commit e77ea11, Python 2.7 is no longer supported.
The easiest way is:
python3 -m pip install virtualenv
For additional help, see virtualenv.
Enter the NDS neahtta directory
cd neahttadigisanit/neahtta/
Find the path of your python3.9 installation
which python3.9
/usr/bin/python3.9
Create a virtualenv using the returned path
python3 -m virtualenv -p /usr/bin/python3.9 .venv
Now whenever you intend to work in the project, you can run the following:
. .venv/bin/activate
And this will switch the paths to use the proper Python installation, with all of the projects packages installed.
You should see some feedback in the command line or path that the virtual environment is active. To test that you are running the desired Python version, you may execute python -V while in the virtualenv, and ensure the response is the correct Python version.
These are needed for installing the lxml package in pip.
In Debian/Ubuntu:
sudo apt install python-dev libxml2-dev libxslt-dev
NB: you only need to do this the first time you install the virtualenv, or whenever pyproject.toml changes.
Switch to the neahtta directory:
cd neahttadigisanit/neahtta/
And with the virtual environment active, run the following:
python -m pip install -e ".[dev]"
Note, you do not need to run this as a super user, if you do, there are some other problems.
NDS requires some Node modules to compress CSS and JS. First follow the install steps on node’s website for the current LTS edition: http://nodejs.org/
This should install both Node.js and the related package manager, npm. Once done confirm npm is installed:
npm
If it is there, switch to the neahtta/neahtta directory, and install:
cd neahttadigisanit/neahtta/neahtta/
npm install
This will read dependencies from package.json to the directory
node_modules/ and run a post-install script for these.
With the environment prepared, you may start work on NDS. However, if you need to set up the environment again, all you need to do is source the virtualenv file:
. .venv/bin/activate
… and then start a development server
fab dev PROJNAME
NB: for some changes to config files you will need to stop and restart the development server.
You might see an error like:
(env) $ fab dev saanih
[localhost] Executing task 'saanih'
Warning: Unable to load SSH config file '/Users/username/.ssh/config'
If this is the case, check your home directory ~/.ssh/config, and confirm that you have access to it: sometimes permissions get weird.
* Missing dependency in $PATH: uglifyjs
Install the executable, check that it is available in $PATH,
and check that it's executable.
The error means what it says, however there are some things to check:
Look at the output of which uglifyjs, if there is nothing:
npm install really worked, and there are executables to be found in .../neahtta/node_modules/.bin/, and that there were no errors from that commandnode_modules/.bin/You may encounter the message UnknownLocaleError: unknown locale 'sma' or a similar one on starting up or compiling strings.
Some of our interface languages are not in the standard Babel list of possible locales (.dat files). Therefore, the required files must be copied from the NDS localedata ddirectory into babel’s locale-data directory. This should be done automatically by NDS if encountered while running (see i18n/utils.py:copy_custom_locales), but if it is not, you may have to do it manually. The files should be put in neahttadigisanit/src/env/lib/python3.9/site-packages/babel/locale-data/sma.dat (or another file for another language). All existing custom localization files are provided for convenience in the repository. If the one you need is not there, then you need to generate it yourself. See instructions at NDSLocalisations.