Skip to content

LibCrowds/pybossa-lc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pybossa-lc

Build Status Coverage Status

A PYBOSSA plugin for managing LibCrowds projects.

The plugin is designed to work in conjunction with the LibCrowds frontend and contains functions for generating LibCrowds projects and analysing their results.

It analyses task run data and sends the final results to a Web Annotation server. It also defines a templating system for configuring and generating projects.

For details of how project creation and results analysis works in LibCrowds, see the LibCrowds Documentation.

Installation

cd /path/to/pybossa/pybossa/plugins
git clone https://github.com/LibCrowds/pybossa-lc
cp -r pybossa-lc/pybossa_lc pybossa_lc
source ../../env/bin/activate
cd pybossa-lc
pip install -r requirements.txt

The plugin will be available after you restart the server.

If your database is already populated when installing this plugin you may need to run the migration functions in cli; see each module and it's associated docstring for details.

Configuration

The following settings should be added to your main PYBOSSA configuration file:

# SPA server name
SPA_SERVER_NAME = 'https://example.com'

# The base URL of an Explicates Annotation server
WEB_ANNOTATION_BASE_URL = 'https://annotations.example.com'

Testing

As this plugin relies on core functions of PYBOSSA the easiest way to test it is use the PYBOSSA testing environment.

# setup PYBOSSA
git clone --recursive https://github.com/Scifabric/pybossa.git
cd pybossa
vagrant up
vagrant ssh

# setup pybossa-lc
git clone https://github.com/LibCrowds/pybossa-lc
cd pybossa-lc
pip install -r requirements.txt

# test
nosetests test/