Skip to main content

Pygeonlp WebAPI Server

Project description

pygeonlp-webapi, A json-rpc webapi server for pygeonlp

pygeonlp-webapi is a WSGI module to use pygeonlp features as a JSON-RPC web service.

How To Use

The server for development using Flask can be run with the following command.

$ python -m pygeonlp_webapi.app

or

$ FLASK_APP="pygeonlp_webapi.app" flask run --port=5000

If you prefer gunicorn, you can run the following command.

$ gunicorn pygeonlp_webapi.app:app --bind=127.0.0.1:5000

Then, post a JSON-RPC message to the server.

$ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc": "2.0", "method": "geonlp.parse", "params":{"sentence":"NIIは千代田区にあります。"}, "id":"1"}' http://localhost:5000/api

More detailed Japanese documentation of the software including API is available under /doc directory. You can also find the latest online documentation at Web Service section in GeoNLP Documentation.

Pre-requirements

pygeonlp-webapi requires pygeonlp and flask-jsonrpc.

Install

The pygeonlp-webapi package can be installed with the pip command. It is recommended that you upgrade pip and setuptools to the latest versions before running it.

$ pip install --upgrade pip setuptools
$ pip install pygeonlp-webapi

The database needs to be prepared the first time.

Prepare the database

Execute the command to register the basic place name word analysis dictionaries (*.json, *.csv) in this package into the database under the default diretory.

>>> import pygeonlp.api as api
>>> api.setup_basic_database()

Run tests (Optional)

Run the unit tests with pytest command.

Uninstall

Use pip command to uninstall.

$ pip uninstall pygeonlp-webapi

License

The 2-Clause BSD License

Acknowledgements

This software is supported by DIAS (Data Integration and Analysis System) and ROIS-DS CODH (Center for Open Data in the Humanities).

It was also supported by JST (Japan Science and Technology Agency) PRESTO program.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygeonlp_webapi-1.1.1.zip (12.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page