1
0
mirror of https://github.com/gsi-upm/senpy synced 2024-09-20 22:01:41 +00:00
Go to file
J. Fernando Sánchez a857dd3042 Typo in README
2015-04-26 20:47:29 +02:00
docs Added docs 2015-02-24 09:03:36 +01:00
plugins PEP8+Better JSON-LD support 2015-02-24 07:15:25 +01:00
senpy Improved message when no plugins are found 2015-02-24 07:37:51 +01:00
tests Improved message when no plugins are found 2015-02-24 07:37:51 +01:00
.travis.yml Forcing Travis 2015-02-24 07:50:14 +01:00
app.py Better readme, fixed app.py 2015-02-24 08:43:00 +01:00
config.py Simple server 2014-07-13 15:39:31 +02:00
dev-requirements.txt PEP8 compliance 2014-11-20 19:29:49 +01:00
LICENSE.txt Refactoring, name change 2014-09-16 16:45:06 +02:00
logo_fp7.gif Better readme, fixed app.py 2015-02-24 08:43:00 +01:00
logo_grande.png Better readme, fixed app.py 2015-02-24 08:43:00 +01:00
logo.png Added plugin architecture 2014-10-17 12:47:17 +02:00
MANIFEST.in Better jsonld support 2014-11-27 11:27:05 +01:00
NOTICE Refactoring, name change 2014-09-16 16:45:06 +02:00
Procfile Simple server 2014-07-13 15:39:31 +02:00
README.rst Typo in README 2015-04-26 20:47:29 +02:00
requirements.txt Fixed requirements 2015-02-24 07:54:58 +01:00
setup.cfg Better readme, fixed app.py 2015-02-24 08:43:00 +01:00
setup.py Improved message when no plugins are found 2015-02-24 07:37:51 +01:00
supervisord.conf Files for deployment 2014-11-05 19:17:27 +01:00

.. image:: logo.png
   :height: 6em
   :align: left

=====================================
`Senpy <http://senpy.herokuapp.com>`_
=====================================
.. image:: https://travis-ci.org/gsi-upm/senpy.svg?branch=master
    :target: https://travis-ci.org/gsi-upm/senpy

Sentiment analysis web services using a common interface: NIF+JSON-LD.

With Senpy, you can easily turn your sentiment analysis algorithm into a web service, just by creating a new plugin.

`DEMO on Heroku <http://senpy.herokuapp.com>`_

Installation
------------
The stable version can be installed via pip:

.. code:: bash

   pip install senpy

   
Alternatively, you can use the development version:
 
.. code:: bash

   git clone git@github.com:gsi-upm/senpy
   cd senpy
   pip install -r requirements.txt 
   
To install it system-wide, use setuptools:

.. code:: bash

   python setup.py install
   
Using
-----

You can use the modules included in senpy to build your own application.
However, the easiest and recommended way is to just use the command-line tool to load your plugins and launch the server.

.. code:: bash

   python -m senpy

This will create a server with any modules found in the current path.
For more options, see the `--help` page.

TO-DO
-----

* Installation instructions
* Improve documentation and generate it with Sphinx
* ReadTheDocs
* Improve README


Acknowledgement
---------------
EUROSENTIMENT PROJECT
Grant Agreement no: 296277
Starting date: 01/09/2012
Project duration: 24 months

.. image:: logo_grande.png
    :target: logo_grande.png
    :width: 100px
    :alt: Eurosentiment Logo

.. image:: logo_fp7.gif
    :width: 100px
    :target: logo_fp7.gif