README.rst 3.4 KB
Newer Older
1
.. image:: img/header.png
2
   :width: 100%
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

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
   pip install -U --user senpy
27 28 29 30 31 32

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

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

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

39 40
Docker Image
************
41
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 gsiupm/senpy --default-plugins``.
42

43
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``
44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91

Developing
----------

Developing/debugging
********************
This command will run the senpy container using the latest image available, mounting your current folder so you get your latest code:

.. code:: bash


    # Python 3.5
    make dev
    # Python 2.7
    make dev-2.7

Building a docker image
***********************

.. code:: bash


    # Python 3.5
    make build-3.5
    # Python 2.7
    make build-2.7

Testing
*******

.. code:: bash


    make test

Running
*******
This command will run the senpy server listening on localhost:5000

.. code:: bash


    # Python 3.5
    make run-3.5
    # Python 2.7
    make run-2.7

92
Usage
93 94 95 96 97 98
-----

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

.. code:: bash

99

100 101 102 103 104 105
   senpy

or, alternatively:

.. code:: bash

106

107 108
    python -m senpy

109 110 111

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

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

115 116 117 118 119 120 121
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>`_
122

123 124 125

For more information, check out the `documentation <http://senpy.readthedocs.org>`_.
------------------------------------------------------------------------------------
126 127 128 129


Acknowledgement
---------------
130 131 132 133 134 135 136 137 138 139 140
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