You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
drevicko 0394bcd69c add make version to readme for pip install
pip install needs the VERSION file - `make version` will create that file

I also added the -U flag to pip install to force install (this is important if the user is playing with the code or trying out different older versions, as pip will not install if it thinks the git repo represents a version already installed or older than the one installed)
7 years ago
docs Fixed conversion docs 7 years ago
img Started readthedocs and improved README 9 years ago
senpy Added fallback version '0.0' 7 years ago
tests Improved docs and client 7 years ago
.drone.yml Improved plugins API and loading 8 years ago
.gitignore Deployment changes 7 years ago
.gitlab-ci.yml Fix 5 7 years ago
.pre-commit-config.yaml Fixed CI problem 7 years ago
.travis.yml Testing docker in travis 7 years ago
Dockerfile.template Changed data directory 7 years ago
LICENSE.txt Refactoring, name change 10 years ago
MANIFEST.in Added gitlab CI 7 years ago
Makefile Added fallback version '0.0' 7 years ago
NOTICE Refactoring, name change 10 years ago
Procfile Fix for heroku 8 years ago
README.rst add make version to readme for pip install 7 years ago
config.py Simple server 10 years ago
dev-requirements.txt PEP8 compliance 10 years ago
requirements.txt Loads of changes! 7 years ago
setup.cfg Fixed bugs in Ekman2VAD 7 years ago
setup.py Loads of changes! 7 years ago
supervisord.conf Files for deployment 10 years ago
test-requirements.txt Deployment changes 7 years ago

README.rst

.. image:: img/header.png
   :height: 6em
   :target: http://demos.gsi.dit.upm.es/senpy

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

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).

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:

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

Installation
------------
The stable version can be installed in three ways.

Through PIP
***********

.. code:: bash

   make version
   pip install -U --user senpy

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

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

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

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

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

Usage
-----

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

.. code:: bash

   senpy

or, alternatively:

.. 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.

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

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>`_


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


Acknowledgement
---------------
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