README.rst 4.67 KB
Newer Older
1
.. image:: img/header.png
2
   :width: 100%
3
   :target: http://senpy.gsi.upm.es
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
10
11
12
13
14
15
16
.. image:: https://lab.gsi.upm.es/senpy/senpy/badges/master/pipeline.svg
   :target: https://lab.gsi.upm.es/senpy/senpy/commits/master

.. image:: https://lab.gsi.upm.es/senpy/senpy/badges/master/coverage.svg
   :target: https://lab.gsi.upm.es/senpy/senpy/commits/master

.. image:: https://img.shields.io/pypi/l/requests.svg
   :target: https://lab.gsi.upm.es/senpy/senpy/

17
18
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).
19

20
21
22
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:
23

24
`See it in action. <http://senpy.gsi.upm.es/>`_
25

26
27
Installation
------------
28
29
30
31
The stable version can be installed in three ways.

Through PIP
***********
32

33
34
.. code:: bash

35
   pip install -U --user senpy
36
37
38
39
40
41

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

42
   git clone http://github.com/gsi-upm/senpy
43
   cd senpy
44
   pip install --user .
45

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

48
49
Docker Image
************
50
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 gsiupm/senpy``.
51

52
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 -f /plugins``
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
92
93
94
95
96
97
98
99
100

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

101
Usage
102
103
104
105
106
107
-----

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

.. code:: bash

108

109
110
111
112
113
114
   senpy

or, alternatively:

.. code:: bash

115

116
117
    python -m senpy

118
119
120

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

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

124
125
126
127
128
129
130
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>`_
131

132
133
134

For more information, check out the `documentation <http://senpy.readthedocs.org>`_.
------------------------------------------------------------------------------------
135
136


137
138
139
140
141
142
143
144
145
146
Python 2.x compatibility
------------------------

Keeping compatibility between python 2.7 and 3.x is not always easy, especially for a framework that deals both with text and web requests.
Hence, starting February 2019, this project will no longer make efforts to support python 2.7, which will reach its end of life in 2020.
Most of the functionality should still work, and the compatibility shims will remain for now, but we cannot make any guarantees at this point.
Instead, the maintainers will focus their efforts on keeping the codebase compatible across different Python 3.3+ versions, including upcoming ones.
We apologize for the inconvenience.


147
148
149
150
151
152
153
154
155
156
157
Having problems with senpy?
---------------------------

Please, file a new issue `on GitHub <https://github.com/gsi-upm/senpy/issues>`_ including enough details to reproduce the bug, including:

  * Operating system
  * Version of senpy (or docker tag)
  * Installed libraries
  * Relevant logs
  * A simple code example

158
159
Acknowledgement
---------------
160
161
162
163
164
165
166
167
168
169
170
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