[Issue #248] Add IBM AlchemyAPI extraction example

[shirleyqt]

This example takes an article of zika as the extracted file and uses IBM AlchemyAPI to analyze the contents. Analyzed results are passed to four functions: entities, keyword, concept, and language.

Related wiki page: https://github.com/TextDB/textdb/wiki/AlchemyAPI-(IBM-Bluemix-Watson)

[chenlica]

Thanks. Please create a wiki page to give an overview of this comparison, and let @xuxip review both this PR and the wiki page.

[shirleyqt]

@chenlica @xuxip Wiki page is done and ready for review. It's under "AlchemyAPI (IBM Bluemix Watson)".

[chenlica]

@xuxip Please review it first.

[xuxip]

Overall looks good. Below are several suggestions.

• __init__.py is empty. I think it can be removed.
• alchemyapi.pyc is a python byte code file. This also can be removed.
• extract.py requires requests module to run. Please include requests module installation instructions on the wiki page.

[kishore-narendran]

Some notes -

• You will have to add *.pyc to the .gitignore file.
• You will find all the Python related files that you need to ignore here -https://github.com/github/gitignore/blob/master/Python.gitignore

[kishore-narendran]

Some more notes for this PR -

• Make a virtualenv for your AlchemyAPIExample. Use this for reference - http://docs.python-guide.org/en/latest/dev/virtualenvs/. Let me know if you have any concerns on how to set this up for your Python project.
• Introduce a requirements.txt at the AlchemyAPIExample/ level for the dependencies that AlchemyAPIExample needs.

[zuozhiw]

@kishore-narendran I think virtualenv is an overkill for this small PR. It seems like only one module requests is needed for this code to work.
So @fukoyui can add a readme.txt to make this requirement explicit. Please also include a few links of how to install requests module both in readme.txt and in the wiki page.

Since we didn't have the time to review this today, after @fukoyui takes care of these comments, Kishore and I can do another review, so @fukoyui can move on to evaluate next tool.

[kishore-narendran]

@zuozhiw @fukoyui That is fair enough, but we will need a requirements.txt file at least, so the appropriate dependencies can be installed to run the IBM Alchemy API demos.

[chenlica]

Agreed on the comment by @zuozhiw . In general, we want to minimize the number of external dependencies.

@kishore-narendran Please also review the corresponding wiki page.

[chenlica]

@fukoyui Are we allowed to put this key here (in public)? If not, we remove it, and we will put the key in our internal files (on google drive)

[shirleyqt]

I will remove this key and put it on our google drive.

[chenlica]

Can we rename it to "readme.md" and use the markdown syntax? Check an example in another PR about Lingpipe: https://github.com/TextDB/textdb/pull/262/files

[shirleyqt]

Done with the change.

[chenlica]

Let's not put this third-party code in the folder with our own code. I had a chat with @zuozhiw and he said the python library has to be under the same folder.

I suggest we do the following: under this folder, create a subfolder called "third-party", and move this alchemyapi.py there. Modify own code accordingly.

@fukoyui can you make the changes?

[shirleyqt]

@chenlica Python treats "third-party" as invalid syntax after moving it to a subdirectory named "third-party", but in "thirdparty" it works fine. Is it fine to use "thirdparty"?

[chenlica]

It's OK to use thirdparty.

[chenlica]

I reviewed this PR and left some comments for @fukoyui to take care.

I also reviewed and polished the wiki page #269 .

@xuxip Did you follow the instructions on wiki? Also did you try to run the python program to make it work?

[xuxip]

@chenlica I was able to successfully compile and run the python program. The wiki page looks good to me. I suggest @fukoyui to make a reference to the sample code /sandbox/AlchemyAPIexample/extract.py in Step 5 of part 2.

[chenlica]

Thanks, @xuxip .

@fukoyui Please make the suggested changes and then do the merge.

[chenlica]

Please fix this conflict.

[shirleyqt]

Since I move alchemyapi.py to a subdirectory, do we have to another review before doing the merge? @chenlica

[chenlica]

@fukoyui please merge the master into your branch then do the merge!