|
1 | | -[](https://travis-ci.org/rosette-api/python) [](https://badge.fury.io/py/rosette-api) [](https://img.shields.io/pypi/pyversions/rosette-api.svg?color=dark%20green&label=Python%20Versions) |
2 | | - |
3 | | -## This is the Python client binding for Rosette API. |
4 | | -You can get an API Key and learn more [here](https://developer.rosette.com). |
5 | | -For more detailed information check out our [features and functions page](https://developer.rosette.com/features-and-functions). |
6 | | - |
7 | | -### Installation |
| 1 | +[](https://travis-ci.org/rosette-api/python) |
| 2 | +[](https://badge.fury.io/py/rosette-api) |
| 3 | +[](https://img.shields.io/pypi/pyversions/rosette-api.svg?color=dark%20green&label=Python%20Versions) |
8 | 4 |
|
9 | | -The Python binding requires Python 2.7+ or 3.4+ and is available through pip: |
| 5 | +--- |
| 6 | +<a href="https://www.rosette.com"><img src="https://s3.amazonaws.com/styleguide.basistech.com/logos/rosette-logo.png /></a> |
10 | 7 |
|
11 | | -`pip install rosette_api` |
12 | | - |
13 | | -If the version you are using is not [the latest from PyPI](https://pypi.org/project/rosette_api/#history), |
14 | | -please check for its [**compatibilty with api.rosette.com**](https://developer.rosette.com/features-and-functions?python). |
15 | | -If you have an on-premise version of Rosette API server, please contact support for |
16 | | -binding compatibility with your installation. |
17 | | - |
18 | | -To check your installed version: |
19 | | - |
20 | | -`pip show rosette_api` |
| 8 | +## Rosette API |
| 9 | +The Rosette Text Analytics Platform uses natural language processing, statistical modeling, and machine learning to |
| 10 | +analyze unstructured and semi-structured text across 364 language-encoding-script combinations, revealing valuable |
| 11 | +information and actionable data. Rosette provides endpoints for extracting entities and relationships, translating and |
| 12 | +comparing the similarity of names, categorizing and adding linguistic tags to text and more. |
21 | 13 |
|
22 | | -### Basic Usage |
| 14 | +## Quick Start |
23 | 15 |
|
24 | | -For help in how to call the various endpoints, please refer to the [examples](https://github.com/rosette-api/python/tree/develop/examples). |
25 | | - |
26 | | -### Supported Endpoints |
27 | | -- categories |
28 | | -- entities |
29 | | -- info |
30 | | -- language |
31 | | -- morphology (complete, compound components, han readings, lemmas, parts of speech) |
32 | | -- name deduplication |
33 | | -- name similarity |
34 | | -- name translation |
35 | | -- ping |
36 | | -- relationships |
37 | | -- semantic similarity |
38 | | -- semantic vectors |
39 | | -- sentences |
40 | | -- sentiment |
41 | | -- syntax dependencies |
42 | | -- tokens |
43 | | -- topics |
44 | | -- transliteration |
45 | | - |
46 | | -### API Documentation |
47 | | -See [documentation](http://rosette-api.github.io/python) |
48 | | - |
49 | | -### Release Notes |
50 | | -See [wiki](https://github.com/rosette-api/python/wiki/Release-Notes) |
| 16 | +#### Installation |
| 17 | +`pip install rosette_api` |
51 | 18 |
|
52 | | -### Docker |
53 | | -A Docker image for running the examples against the compiled source library is available on Docker Hub. |
| 19 | +#### Examples |
| 20 | +There is an example call for each Rosette endpoint, using this binding, |
| 21 | +in the [examples](https://github.com/rosette-api/python/tree/develop/examples) directory. |
54 | 22 |
|
55 | | -Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-python` |
| 23 | +#### Documentation & Support |
| 24 | +- [Binding API](https://rosette-api.github.io/python/) |
| 25 | +- [Rosette Platform API](https://developer.rosette.com/features-and-functions) |
| 26 | +- [Release Notes](https://github.com/rosette-api/python/wiki/Release-Notes) |
| 27 | +- [Binding/Platform Compatibility](https://developer.rosette.com/features-and-functions?python#) |
| 28 | +- [Support](https://support.rosette.com) |
56 | 29 |
|
57 | | -Additional environment settings: |
58 | | -- `-e ALT_URL=<alternative URL>` |
59 | | -- `-e FILENAME=<single filename>` |
| 30 | +## Rosette API Access |
| 31 | +- Rosette Cloud [Sign Up](https://developer.rosette.com/signup) |
| 32 | +- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/) |
60 | 33 |
|
| 34 | +## Developer Information |
| 35 | +If you are modifying the binding code, please refer to the [developer README](https://github.com/rosette-api/python/tree/develop/DEVELOPER.md) file. |
0 commit comments