README.rst 2.03 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
.. 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.

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

17
18
19
Installation
------------
The stable version can be installed via pip:
20

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.. 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
39
40
41
42
43
44
45
46
47


If you are using docker, build the image or use the pre-built one:

.. code:: bash

    docker run -ti -p 5000:5000 balkian/senpy --host 0.0.0.0 --default-plugins

To add custom plugins, add a volume and tell senpy where to find the plugins:
48
   
49
50
51
52
.. code:: bash

    docker run -ti -p 5000:5000 -v <PATH OF PLUGINS:/plugins balkian/senpy --host 0.0.0.0 --default-plugins -f /plugins

53
54
55
56
57
58
59
60
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

61
62
63
64
65
66
67
68
   senpy

or, alternatively:

.. code:: bash

    python -m senpy

69
70
71

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

73

74
75
76
TO-DO
-----

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
77
* Improve documentation and generate it with Sphinx
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
* 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