balkian/senpy
1
0
Fork 0
mirror of https://github.com/gsi-upm/senpy synced 2024-11-16 05:12:30 +00:00
Code Issues Releases Wiki Activity
7fd16a17fb
senpy/docs/server.rst

59 lines
2.0 KiB
ReStructuredText
Raw Normal View History

Clearer docs
2017-06-09 15:21:19 +00:00
Server
======
Improve docs. (Badges missing)
2017-04-07 12:19:08 +00:00
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
The senpy server is launched via the `senpy` command:
Improve docs. (Badges missing)
2017-04-07 12:19:08 +00:00
Clearer docs
2017-06-09 15:21:19 +00:00
.. code:: text
Improve docs. (Badges missing)
2017-04-07 12:19:08 +00:00
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
usage: senpy [-h] [--level logging_level] [--debug] [--default-plugins]
[--host HOST] [--port PORT] [--plugins-folder PLUGINS_FOLDER]
[--only-install]
Improve docs. (Badges missing)
2017-04-07 12:19:08 +00:00
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
Run a Senpy server
optional arguments:
-h, --help show this help message and exit
--level logging_level, -l logging_level
Logging level
--debug, -d Run the application in debug mode
--default-plugins Load the default plugins
--host HOST Use 0.0.0.0 to accept requests from any host.
--port PORT, -p PORT Port to listen on.
--plugins-folder PLUGINS_FOLDER, -f PLUGINS_FOLDER
Where to look for plugins.
--only-install, -i Do not run a server, only install plugin dependencies
When launched, the server will recursively look for plugins in the specified plugins folder (the current working directory by default).
Clearer docs
2017-06-09 15:21:19 +00:00
For every plugin found, it will download its dependencies, and try to activate it.
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
The default server includes a playground and an endpoint with all plugins found.
Clearer docs
2017-06-09 15:21:19 +00:00
Let's run senpy with the default plugins:
.. code:: bash
senpy -f . --default-plugins
Now go to `http://localhost:5000 <http://localhost:5000>`_, you should be greeted by the senpy playground:
.. image:: senpy-playground.png
:width: 100%
:alt: Playground
The playground is a user-friendly way to test your plugins, but you can always use the service directly: `http://localhost:5000/api?input=hello <http://localhost:5000/api?input=hello>`_.
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
By default, senpy will listen only on the `127.0.0.1` address.
That means you can only access the API from your (or localhost).
Clearer docs
2017-06-09 15:21:19 +00:00
You can listen on a different address using the `--host` flag (e.g., 0.0.0.0).
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
The default port is 5000.
Clearer docs
2017-06-09 15:21:19 +00:00
You can change it with the `--port` flag.
Removed nbsphinx It requires pandoc, which cannot be installed with pip. We can either link to the nbfile or convert the file manually/automatically: ``` nbconvert SenpyClientUse.ipynb --to rst ```
2017-04-10 18:04:36 +00:00
For instance, to accept connections on port 6000 on any interface:
.. code:: bash
senpy --host 0.0.0.0 --port 6000
For more options, see the `--help` page.
Reference in New Issue Copy Permalink