README.rst 2.79 KB
Newer Older
1
.. image:: img/header.png
2
   :height: 6em
3
   :target: http://demos.gsi.dit.upm.es/senpy
4
5

.. image:: https://travis-ci.org/gsi-upm/senpy.svg?branch=master
6
   :target: https://travis-ci.org/gsi-upm/senpy
7

8
9
Senpy lets you create sentiment analysis web services easily, fast and using a well known API.
As a bonus, senpy services use semantic vocabularies (e.g. `NIF <http://persistence.uni-leipzig.org/nlp2rdf/>`_, `Marl <http://www.gsi.dit.upm.es/ontologies/marl>`_, `Onyx <http://www.gsi.dit.upm.es/ontologies/onyx>`_) and formats (turtle, JSON-LD, xml-rdf).
10

11
12
13
Have you ever wanted to turn your sentiment analysis algorithms into a service?
With senpy, now you can.
It provides all the tools so you just have to worry about improving your algorithms:
14

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
15
`See it in action. <http://senpy.cluster.gsi.dit.upm.es/>`_
16

17
18
Installation
------------
19
20
21
22
The stable version can be installed in three ways.

Through PIP
***********
23

24
25
.. code:: bash

26
27
   make version
   pip install -U --user senpy
28
29
30
31
32
33

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

34
   git clone http://github.com/gsi-upm/senpy
35
   cd senpy
36
   pip install --user .
37

38
If you want to install senpy globally, use sudo instead of the ``--user`` flag.
39

40
41
Docker Image
************
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
42
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 gsiupm/senpy --default-plugins``.
43

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
44
To add custom plugins, add a volume and tell senpy where to find the plugins: ``docker run -ti -p 5000:5000 -v <PATH OF PLUGINS>:/plugins gsiupm/senpy --default-plugins -f /plugins``
45

46
Usage
47
48
49
50
51
52
-----

However, the easiest and recommended way is to just use the command-line tool to load your plugins and launch the server.

.. code:: bash

53
54
55
56
57
58
59
60
   senpy

or, alternatively:

.. code:: bash

    python -m senpy

61
62
63

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

65
Alternatively, you can use the modules included in senpy to build your own application.
66

67
68
69
70
71
72
73
Deploying on Heroku
-------------------
Use a free heroku instance to share your service with the world.
Just use the example Procfile in this repository, or build your own.


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

75
76
77

For more information, check out the `documentation <http://senpy.readthedocs.org>`_.
------------------------------------------------------------------------------------
78
79
80
81


Acknowledgement
---------------
82
83
84
85
86
87
88
89
90
91
92
This development has been partially funded by the European Union through the MixedEmotions Project (project number H2020 655632), as part of the `RIA ICT 15 Big data and Open Data Innovation and take-up` programme.


.. image:: img/me.png
    :target: http://mixedemotions-project.eu
    :height: 100px
    :alt: MixedEmotions Logo

.. image:: img/eu-flag.jpg
    :height: 100px
    :target: http://ec.europa.eu/research/participants/portal/desktop/en/opportunities/index.html