From 1c1efddd9b51fc8f3cfa2a1ca2985a73d6ea485a Mon Sep 17 00:00:00 2001 From: Slater-Victoroff Date: Fri, 27 Feb 2015 17:22:22 -0500 Subject: [PATCH 1/2] Added classifiers and Annie to pypi stuff --- CHANGES.txt | 1 + README.rst | 2 +- indicoio/__init__.py | 2 +- setup.py | 26 +++++++++++++++++++++----- 4 files changed, 24 insertions(+), 7 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 7984ade..eb5f989 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -19,3 +19,4 @@ v0.4.13, Fri Dec 19 -- Added optional arguments to text tags API v0.4.14, Sat Dec 20 -- Fix for batch image features preprocessing, increased test coverage v0.4.15, Sat Dec 20 -- Bug fix release v0.5.0, Friday Feb 27 -- Updated to support private cloud, allows for indicorc file to reduce redundant authorization calls, README updates +v0.5.1, Friday Feb 27 -- More README updates, fixed rst formatting issue, added classifiers diff --git a/README.rst b/README.rst index ff1b9a6..4b0ab29 100644 --- a/README.rst +++ b/README.rst @@ -126,7 +126,7 @@ Examples Environment variables take precedence over any configuration found in the indicorc file. The following environment variables are valid: - -:math:`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 diff --git a/indicoio/__init__.py b/indicoio/__init__.py index 58e53de..c265775 100644 --- a/indicoio/__init__.py +++ b/indicoio/__init__.py @@ -2,7 +2,7 @@ from functools import partial JSON_HEADERS = {'Content-type': 'application/json', 'Accept': 'text/plain'} -Version, version, __version__, VERSION = ('0.5.0',) * 4 +Version, version, __version__, VERSION = ('0.5.1',) * 4 from indicoio.text.sentiment import political, posneg from indicoio.text.sentiment import posneg as sentiment diff --git a/setup.py b/setup.py index d432a8b..185dcc8 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ except ImportError: setup( name="IndicoIo", - version='0.5.0', + version='0.5.1', packages=[ "indicoio", "indicoio.text", @@ -23,12 +23,28 @@ setup( license="MIT License (See LICENSE)", long_description=open("README.rst").read(), url="https://github.com/IndicoDataSolutions/indicoio-python", - author="Alec Radford, Slater Victoroff, Aidan McLaughlin", + author="Alec Radford, Slater Victoroff, Aidan McLaughlin, Anne Carlson", author_email=""" - Alec Radford , - Slater Victoroff , - Aidan McLaughlin + Alec Radford , + Slater Victoroff , + Aidan McLaughlin , + Anne Carlson + """, + classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "License :: OSI Approved :: MIT License", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Topic :: Scientific/Engineering", + "Topic :: Scientific/Engineering :: Image Recognition", + "Topic :: Scientific/Engineering :: Information Analysis", + "Topic :: Software Development", + "Topic :: Software Development :: Libraries :: Python Modules", + ], setup_requires=[ "numpy >= 1.8.1", "six >= 1.3.0", From 273798e4d0e8874a175a301941cd968dc2dad5d2 Mon Sep 17 00:00:00 2001 From: Madison May Date: Fri, 27 Feb 2015 17:47:54 -0500 Subject: [PATCH 2/2] Markdown fixes. --- README.md | 17 ++++++++------ README.rst | 67 +++++++++++++++++++++++++++++++++--------------------- 2 files changed, 51 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 20f19dc..2cfb0da 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Examples >>> language_dict {u'Swedish': 0.00033330636691921914, u'Lithuanian': 0.007328693814717631, u'Vietnamese': 0.0002686116137658802, u'Romanian': 8.133913804076592e-06, ...} - +``` 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", "********")) ``` -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 ------------------------ @@ -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", "********")) ``` -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 ------------------------ @@ -124,8 +124,11 @@ cloud = example Environment variables take precedence over any configuration found in 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 configuration options set in the indicorc file or in an environment variable. diff --git a/README.rst b/README.rst index 4b0ab29..76f63f1 100644 --- a/README.rst +++ b/README.rst @@ -82,51 +82,66 @@ Examples >>> language_dict {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. - - from indicio import batch\_sentiment batch\_sentiment(['Text - to analyze', 'More text'], auth=("example@example.com", - "\*\*\*\*\*\*\*\*")) +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", "********")) - 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. - - from indicio import sentiment sentiment("Text to analyze", - cloud="example", auth=("example@example.com", - "\*\*\*\*\*\*\*\*")) +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", "********")) - 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 -the indicorc file. The following environment variables are valid: - -$INDICO\_USERNAME - $INDICO\_PASSWORD - $INDICO\_CLOUD +the indicorc file. The following environment variables are valid: + +:: + + $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