wassname/IndicoIo-python
1
0
Fork 0
mirror of https://github.com/wassname/IndicoIo-python.git synced 2026-08-12 11:40:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Markdown fixes.

Browse Source
This commit is contained in:
Madison May
2015-02-27 17:51:55 -05:00
parent 1c1efddd9b
commit 273798e4d0
2 changed files with 51 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -7
View File
@@ -77,7 +77,7 @@ Examples
>>> language_dict >>> language_dict
{u'Swedish': 0.00033330636691921914, u'Lithuanian': 0.007328693814717631, u'Vietnamese': 0.0002686116137658802, u'Romanian': 8.133913804076592e-06, ...} {u'Swedish': 0.00033330636691921914, u'Lithuanian': 0.007328693814717631, u'Vietnamese': 0.0002686116137658802, u'Romanian': 8.133913804076592e-06, ...}
```
Batch API Access Batch API Access
---------------- ----------------
@@ -89,7 +89,7 @@ If you'd like to use our batch api interface, please send an email to contact@in
>>> batch_sentiment(['Text to analyze', 'More text'], auth=("example@example.com", "********")) >>> batch_sentiment(['Text to analyze', 'More text'], auth=("example@example.com", "********"))
``` ```
Authentication credentials can also be set as the environment variables "INDICO_USERNAME" and "INDICO_PASSWORD" or as 'username' and 'password' in the indicorc file. Authentication credentials can also be set as the environment variables `$INDICO_USERNAME` and `$INDICO_PASSWORD` or as `username` and `password` in the indicorc file.
Private cloud API Access Private cloud API Access
------------------------ ------------------------
@@ -101,9 +101,9 @@ If you're looking to use indico's API for high throughput applications, please c
>>> sentiment("Text to analyze", cloud="example", auth=("example@example.com", "********")) >>> sentiment("Text to analyze", cloud="example", auth=("example@example.com", "********"))
``` ```
The `cloud` parameter redirects API calls to your private cloud hosted at [cloud].indico.domains. The `cloud` parameter redirects API calls to your private cloud hosted at `[cloud].indico.domains`
Private cloud subdomains can also be set as the environment variable "INDICO_CLOUD" or as 'cloud' in the indicorc file. Private cloud subdomains can also be set as the environment variable `$INDICO_CLOUD` or as `cloud` in the indicorc file.
Configuration Configuration
------------------------ ------------------------
@@ -124,8 +124,11 @@ cloud = example
Environment variables take precedence over any configuration found in the indicorc file. Environment variables take precedence over any configuration found in the indicorc file.
The following environment variables are valid: The following environment variables are valid:
- $INDICO_USERNAME
- $INDICO_PASSWORD ```
- $INDICO_CLOUD $INDICO_USERNAME
$INDICO_PASSWORD
$INDICO_CLOUD
```
Finally, any values explicitly passed in to an api call will override configuration options set in the indicorc file or in an environment variable. Finally, any values explicitly passed in to an api call will override configuration options set in the indicorc file or in an environment variable.
README.rst
+41 -26
View File
@@ -82,51 +82,66 @@ Examples
>>> language_dict >>> language_dict
{u'Swedish': 0.00033330636691921914, u'Lithuanian': 0.007328693814717631, u'Vietnamese': 0.0002686116137658802, u'Romanian': 8.133913804076592e-06, ...} {u'Swedish': 0.00033330636691921914, u'Lithuanian': 0.007328693814717631, u'Vietnamese': 0.0002686116137658802, u'Romanian': 8.133913804076592e-06, ...}
Batch API Access
----------------
Batch API Access If you'd like to use our batch api interface, please send an email to
---------------- contact@indico.io.
If you'd like to use our batch api interface, please send an email to contact@indico.io.
from indicio import batch\_sentiment batch\_sentiment(['Text
to analyze', 'More text'], auth=("example@example.com",
"\*\*\*\*\*\*\*\*"))
:: ::
>>> from indicio import batch_sentiment
>>> batch_sentiment(['Text to analyze', 'More text'], auth=("example@example.com", "********"))
Authentication credentials can also be set as the environment variables "INDICO_USERNAME" and "INDICO_PASSWORD" or as 'username' and 'password' in the indicorc file. Authentication credentials can also be set as the environment variables
``$INDICO_USERNAME`` and ``$INDICO_PASSWORD`` or as ``username`` and
``password`` in the indicorc file.
Private cloud API Access Private cloud API Access
------------------------ ------------------------
If you're looking to use indico's API for high throughput applications, please contact contact@indico.io about our private cloud option. If you're looking to use indico's API for high throughput applications,
please contact contact@indico.io about our private cloud option.
from indicio import sentiment sentiment("Text to analyze",
cloud="example", auth=("example@example.com",
"\*\*\*\*\*\*\*\*"))
:: ::
>>> from indicio import sentiment
>>> sentiment("Text to analyze", cloud="example", auth=("example@example.com", "********"))
The `cloud` parameter redirects API calls to your private cloud hosted at [cloud].indico.domains. The ``cloud`` parameter redirects API calls to your private cloud hosted
at ``[cloud].indico.domains``
Private cloud subdomains can also be set as the environment variable "INDICO_CLOUD" or as 'cloud' in the indicorc file. Private cloud subdomains can also be set as the environment variable
``$INDICO_CLOUD`` or as ``cloud`` in the indicorc file.
Configuration Configuration
------------------------ -------------
Indicoio-python will search ./.indicorc and $HOME/.indicorc for the optional configuration file. Values in the local configuration file (./.indicorc) take precedence over those found in a global configuration file ($HOME/.indicorc). The indicorc file can be used to set an authentication username and password or a private cloud subdomain, so these arguments don't need to be specified for every api call. All sections are optional. Indicoio-python will search ./.indicorc and
HOME/.indicorc for the optional configuration file. Values in the local configuration file (./.indicorc) take precedence over those found in a global configuration file (`\ HOME/.indicorc).
The indicorc file can be used to set an authentication username and
password or a private cloud subdomain, so these arguments don't need to
be specified for every api call. All sections are optional.
Here is an example of a valid indicorc file: Here is an example of a valid indicorc file:
[auth] username = test@example.com password = secret ::
[private\_cloud] cloud = example \`\`\` [auth]
username = test@example.com
password = secret
[private_cloud]
cloud = example
Environment variables take precedence over any configuration found in Environment variables take precedence over any configuration found in
the indicorc file. The following environment variables are valid: - the indicorc file. The following environment variables are valid:
$INDICO\_USERNAME - $INDICO\_PASSWORD - $INDICO\_CLOUD
::
$INDICO_USERNAME
$INDICO_PASSWORD
$INDICO_CLOUD
Finally, any values explicitly passed in to an api call will override Finally, any values explicitly passed in to an api call will override
configuration options set in the indicorc file or in an environment configuration options set in the indicorc file or in an environment