perseids-project/perseids-client-apps

A simple flask application to serve input forms.

#Installing

Setting up

• Have python3.4 and pip3.4 !
• Have bower installed ! : sudo npm -g install bower
• Have virtualenv installed : sudo apt-get install python-virtualenv
• Create virtualenv : virtualenv flask
• (Optional) Source virtualenv : source flask/bin/activate
• Install dependencies : pip install -r requirements.txt
• Install bower dependencies (in app subfolder) : bower install
• Chmod run.py : chmod a+x run.py
• Run ./run.py and look at http://localhost:5000/treebank

Deployment

• See doc/deployment.md

i18n

Here is a few commands you might need. The translations are located in app/translations and follow .po standards. Feel free to use apps such as PoEdit to enhance, add corections.

• Update Catalog : pybabel extract -F babel.cfg -k lazy_gettext -o messages.pot app
• Create a lang : pybabel init -i messages.pot -d app/translations -l $LANGUAGE
• Update a lang : pybabel update -i messages.pot -d app/translations -l $LANGUAGE
• Compile langs : pybabel compile pybabel compile -f -d app/translations #Alpheios Copyright

  Copyright 2014 The Alpheios Project, Ltd.
  http://alpheios.net
  
  This file is part of Alpheios.
  
  Alpheios is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  Alpheios is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

perseids-client-apps's Issues

move the mongo_db_ops and save data functionality to the digital_milliet app

not sure how this is working live, but when I run the app locally, it can't find this file.

per @PonteIneptique the solution is to change the following in the importing code (views.py):

from mongo_db_ops import add_to_db
to
from app.mongo_db_ops import add_to_db

Fabfile should compile and update PO/MO from babel

See #12

Currently not done by fab.

Deal with joth data in the fabfile

apply normalization to input

we should have the option to normalize text input through the input forms -- most of our services (such as tokenizing splitting) require precombined unicode chars to function properly and we should normalize on input if we can.

found by @vgorman1 -- her μήδε used a combining char (combining \u03b7\u0301) but the code looks for the precombined character (\u03ae).

modules.py - what is the correct default?

the base persids-clients-app repo no longer includes ahab or joth, but the modules.py here still requires them.

not sure what the best way is to manage this -- the deployment scripts look at modules.py to decide whether or not to pull these repos in, but in a manual install if you don't want ahab or joth you have to go in and tweak this file.

Fabfile general

• Rollback
• Symbolic link for prod and stage
• Apache2 site config if needed ? (@balmas Should I take care of that ?)

tokenizer errors aren't being shown to the user

if the tokenizer crashes (such as it does when trying to tokenize 'foveamve' with splitting=true), the user doesn't get any notice of the crash, it just looks like the page hangs. We should catch and display tokenizer crashes.

strip header, extra attributes from published treebank files

From alpheios-project/arethusa#748:

When I try to import into Arethusa a treebank file from the Perseus Latin repository (e. g. phi1221.phi007.perseus-lat1.tb.xml from https://github.com/PerseusDL/treebank_data/blob/master/v2.1/Latin/texts/phi1221.phi007.perseus-lat1.tb.xml) using the "Upload Base XML Treebank / from file" button, I get the message: ERROR!! CHANGES NOT SAVED! errorunexpected attribute "oldId". When I change the file, removing the header element (with all its children) and body (I put in the annotator element from one of my exported treebank annotations), the file is read and displayed OK.
The users often want to review or change already annotated trees from the "gold standard". Arethusa is the logical choice of environment to do so. Perhaps this could be achieved with an XSL or XQuery stylesheet layer which would, on import, strip out from the base XML treebank file everything above the sentence element, and add a treebank element that is acceptable to Arethusa.

Make sure to have rotating log handler ?

See Flask documentation

treebank template should not set relation value to nil

Per alpheios-project/arethusa#759 @gcelano requests that we leave the relation attribute blank rather than setting it to nil when creating a treebank template.

New CTS Linked Data Publication App

Per perseids-project/perseids_docs#259 and discussion with @annakrohn yesterday, for the Digital Millet workflow we want to create a new Perseids input app which allows a user to create a new CTS-driven linked data publication in Perseids. The app should create a JSON-LD data structure using the OA data model which describes the elements of the publication and supplies the initial values. Subsequent editing of the publication will be through the existing application features in Perseids.

The following data types should be able to be created from this from:

1. a new Translation of a specific passage or passage range of a canonical work (entered in plain text not XML)
2. a new Commentary targeting a specific passage or passage range of a canonical work

We also want to be able to specify a keyword or set of keywords and a bibliography, but need to check with @Marie-ClaireBeaulieu about whether these should target the selected CTS passages or the work as a whole, or the linked data publication itself.

Features which might be nice to have but which might be out of scope and need further discussion wrt to the requirements:

1. the ability to choose whether the commentary targets the translation instead of the canonical text
2. the ability to enter more than one commentary
3. the ability to enter more than one translation
4. the ability to specify an existing translation of the canonical passage

digmill use api to ensure no duplicate digmill numbers

perseids-project/digital_milliet#32

digmill input broken

the fix in 0b710fd doesn't fully work -- tested with erasing and replacing retrieved CTS text -- resulted in an annotation that was missing a target

alignment form isn't triggering language and type detection

when we process input from a supplied URL we should always trigger the language and type detection to be sure it's sent to the tokenizer with the right params.

digmill markdownify use broken

I'm not sure if this was taken out intentionally, or something that got lost when the code was merged. The annotation/enter.html looks like it has classes from the markdownify library to enable a widget for entering links into the commentary.

I tried adding it in, but the display gets really wonky then. Needs some effort to fix.

This is currenly only in the digmill branch of this code.

fabfile - not rebuilding messages.mo ?

@PonteIneptique am I missing a step in the fabfile to regenerate the messages.mo binary files? I added a new string to the treebank form, and updated the en and fr messages files, but the deployment isn't picking up the new string, just the default from the template, and I'm guessing it's because messages.mo isn't regenerated?

We really need to document the deployment steps for this...

Add support for supplying semicolon_delimiter param

See
perseids-project/llt-segmenter#1

add support to advanced options for specifying semicolon_delimiter paramter to llt/segtok