51 | Please activate JavaScript to enable the search 52 | functionality. 53 |
54 |56 | From here you can search these documents. Enter your search 57 | words into the box below and click "search". Note that the search 58 | function will automatically search for all of the words. Pages 59 | containing fewer words won't appear in the result list. 60 |
61 | 66 | 67 |' + _('Hide Search Matches') + '
') 206 | .appendTo($('#searchbox')); 207 | } 208 | }, 209 | 210 | /** 211 | * init the domain index toggle buttons 212 | */ 213 | initIndexTable : function() { 214 | var togglers = $('img.toggler').click(function() { 215 | var src = $(this).attr('src'); 216 | var idnum = $(this).attr('id').substr(7); 217 | $('tr.cg-' + idnum).toggle(); 218 | if (src.substr(-9) == 'minus.png') 219 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 220 | else 221 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 222 | }).css('display', ''); 223 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 224 | togglers.click(); 225 | } 226 | }, 227 | 228 | /** 229 | * helper function to hide the search marks again 230 | */ 231 | hideSearchWords : function() { 232 | $('#searchbox .highlight-link').fadeOut(300); 233 | $('span.highlighted').removeClass('highlighted'); 234 | }, 235 | 236 | /** 237 | * make the url absolute 238 | */ 239 | makeURL : function(relativeURL) { 240 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 241 | }, 242 | 243 | /** 244 | * get the current relative url 245 | */ 246 | getCurrentURL : function() { 247 | var path = document.location.pathname; 248 | var parts = path.split(/\//); 249 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 250 | if (this == '..') 251 | parts.pop(); 252 | }); 253 | var url = parts.join('/'); 254 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 255 | } 256 | }; 257 | 258 | // quick alias for translations 259 | _ = Documentation.gettext; 260 | 261 | $(document).ready(function() { 262 | Documentation.init(); 263 | }); 264 | -------------------------------------------------------------------------------- /watsongraph/event_insight_lib.py: -------------------------------------------------------------------------------- 1 | """event-insight.py 2 | This library provides a way to access IBM Watson Bluemix services. 3 | A Python Bluemix-Watson API which would make this module redundant is currently in stalled development by the 4 | Bluemix team. For now, this file's methodology is sufficient.""" 5 | 6 | import json 7 | import os 8 | import requests 9 | from time import gmtime 10 | import urllib 11 | 12 | 13 | def _import_credentials(filename='concept_insight_credentials.json'): 14 | """ 15 | Internal method which finds the credentials file describing the token that's needed to access Watson/Bluemix 16 | services. 17 | 18 | :param filename -- The filename at which Concept Insights service credentials are stored. Defaults to 19 | `concept_insight_credentials.json`. 20 | """ 21 | if filename in [f for f in os.listdir('.') if os.path.isfile(f)]: 22 | data = json.load(open(filename))['credentials'] 23 | return data 24 | else: 25 | raise IOError( 26 | 'This API requires a Bluemix/Watson credentials token to work. Did you forget to define ' 27 | 'one? For more information refer to:\n\nhttps://github.com/ResidentMario/watsongraph#setup') 28 | 29 | 30 | def _generate_token(filename='concept_insight_credentials.json', token_file='token.json'): 31 | """ 32 | Generate the Base64 token that IBM uses for API authorization. Wraps `import_credentials()`. Itself a submethod 33 | of the `getToken()` method. See also `validateToken()`. 34 | 35 | :param filename -- The filename at which Concept Insights service credentials are stored. Defaults to 36 | `concept_insight_credentials.json`. 37 | :param token_file -- The filename at which the token (which this application saves as a file, not an object) 38 | will be stored. Defaults to `token.json`. 39 | """ 40 | credentials = _import_credentials(filename) 41 | r = requests.get( 42 | "https://gateway.watsonplatform.net/authorization/api/v2/token\?url=https://stream.watsonplatform.net" + 43 | "/concept-insights/api", 44 | auth=(credentials['username'], credentials['password'])) 45 | if r.status_code == requests.codes.ok: 46 | f = open(token_file, 'w') 47 | f.write(json.dumps({'token': r.text, 'time': gmtime()}, indent=4)) 48 | return r.text 49 | else: 50 | raise RuntimeError( 51 | 'Could not resolve a Bluemix/Watson API token using the given credentials.' + 52 | 'Are your account credentials correct?') 53 | 54 | 55 | def _validate_token(token_file='token.json'): 56 | """ 57 | The generateToken() method creates a JSON file with both a token and a time parameter. 58 | This methods checks if the token file is still valid. Tokens live for an hour, so if the token was generated 59 | less than an hour ago it should work. In that case the additional overhead of regenerating the token is not 60 | necessary! This method is a submethod of the primary-use `getToken()` method. See also `generateToken()`, above. 61 | 62 | :param token_file -- The filename at which the token (which this application saves as a file, not an object) 63 | will be stored. Defaults to `token.json`. 64 | """ 65 | if token_file in [f for f in os.listdir('.') if os.path.isfile(f)]: 66 | """ 67 | The timestamp is in UTC. The timestamp is in the format [year, month, day, hour, minute, second, ..., ..., ...] 68 | Generated via `gmtime()` in `generateToken()`. See https://docs.python.org/2/library/time.html#time.struct_time 69 | In our case it's simplest to compare the hour parameter and make sure we haven't incremented into the next 70 | hour yet. 71 | """ 72 | timestamp = json.load(open(token_file))['time'] 73 | hourstamp = timestamp[3] 74 | if hourstamp - gmtime()[3] == 0: 75 | return True 76 | else: 77 | return False 78 | else: 79 | return False 80 | 81 | 82 | def get_token(token_file='token.json'): 83 | """ 84 | This is the primary-use access method meant to be used throughout the application. Implements `validateToken()` 85 | and `generateToken()` submethods, above. If a token exists that was created within the current hour, it is still 86 | valid, reused, and returned (fast). If a token exists but has expired, or does not exist at all, one is created 87 | and returned (requires networking, slower). 88 | 89 | :param token_file -- The filename at which the token (which this application saves as a file, not an object) 90 | will be stored. Defaults to `token.json`. 91 | """ 92 | if _validate_token(): 93 | return json.load(open(token_file))['token'] 94 | else: 95 | return _generate_token() 96 | 97 | 98 | def annotate_text(text, content_type='text/plain', token_file='token.json'): 99 | """ 100 | Given the text to be analyzed and a previous generated access token this method returns the result of a Watson 101 | API call to `annotate_text`. This method returns the raw, unprocessed result of an API call; its 102 | output is meant to be processed by other methods making use of API calls made using this method. 103 | 104 | :param text -- The text to be annotated. 105 | :param content_type -- This optional parameter defaults to `text/plain`, which expects plaintext input. 106 | `text/html` is the alternative option. 107 | :param token_file -- The filename at which the token (which this application saves as a file, not an object) 108 | will be stored. Defaults to `token.json`. 109 | """ 110 | token = get_token(token_file) 111 | base_url = 'https://gateway.watsonplatform.net/concept-insights/api/v2/graphs/wikipedia/en-20120601/annotate_text' 112 | headers = {'X-Watson-Authorization-Token': token, 'Content-Type': content_type, 'Accept': 'application/json'} 113 | dat = text.encode(encoding='UTF-8', errors='ignore') 114 | r = requests.post(base_url, headers=headers, data=dat) 115 | # Catch a recurring error of unknown server-side provenance. Further details: 116 | # https://github.com/ResidentMario/watsongraph/issues/6 117 | r.raise_for_status() 118 | return json.loads(r.text) 119 | 120 | 121 | def get_related_concepts(label, level=0, limit=10, token_file='token.json'): 122 | """ 123 | Given the name of a concept within the Wikipedia concept graph, returns the result of an API call to the 124 | `label_search` Watson method. This method requires the name of the concept that is to be searched for. 125 | That name must be precise. 126 | 127 | :param label -- The Concept label for whom relations are being fetched. Note that this method is executed on a 128 | label, not a Concept--executing it on a Concept would incur unnecessary additional overhead. 129 | :param level -- The limit placed on the depth of the graph. A limit of 0 is highest, corresponding with the 130 | most popular articles; a limit of 5 is the broadest and graphs to the widest cachet of articles. This 131 | parameter is a parameter that is passed directly to the IBM Watson API call. 132 | :param limit -- a cutoff placed on the number of related concepts to be returned. This parameter is passed 133 | directly to the IBM Watson API call. 134 | :param token_file -- The filename at which the token (which this application saves as a file, not an object) 135 | will be stored. Defaults to `token.json`. 136 | """ 137 | headers = {'X-Watson-Authorization-Token': get_token(token_file), 138 | 'Content-Type': 'text/plain', 139 | 'Accept': 'application/json'} 140 | # Percent encode the URI according to Wikipedia's encoding scheme. 141 | # noinspection PyUnresolvedReferences 142 | label = urllib.parse.quote(label.replace(' ', '_'), safe='_,') 143 | base_url = 'https://gateway.watsonplatform.net/concept-insights/api/v2/graphs/wikipedia/en-20120601' 144 | base_url += '/related_concepts?concepts=["/graphs/wikipedia/en-20120601/concepts/' + label 145 | base_url += '"]&level=' + str(level) + '&limit=' + str(limit) 146 | r = requests.get(base_url, headers=headers) 147 | r.raise_for_status() 148 | return json.loads(r.text) 149 | 150 | 151 | # noinspection PyUnresolvedReferences 152 | def get_relation_scores(label, list_of_target_labels, token_file='token.json'): 153 | """ 154 | Given the name of a concept within the Wikipedia concept graph and a list of other concepts to be checked against, 155 | returns the result of an API call to the `relation_scores` Watson method. This method requires the name of 156 | the concept that is to be searched for. That name must be precise. 157 | 158 | :param label -- The Concept label for whom relations are being fetched. Note that this method is executed on a 159 | label, not a Concept--executing it on a Concept would incur unnecessary additional overhead. 160 | :param list_of_target_labels -- A list of other labels for which matching correlations will be fetched. 161 | :param token_file -- The filename at which the token (which this application saves as a file, not an object) 162 | will be stored. Defaults to `token.json`. 163 | """ 164 | headers = {'X-Watson-Authorization-Token': get_token(token_file), 165 | 'Content-Type': 'text/plain', 166 | 'Accept': 'application/json'} 167 | # Percent encode the URI according to Wikipedia's encoding scheme. 168 | s_label = urllib.parse.quote(label.replace(' ', '_'), safe='_,') 169 | list_of_target_labels = [urllib.parse.quote(lb.replace(' ', '_'), safe='_,') for lb in list_of_target_labels] 170 | base_url = 'https://gateway.watsonplatform.net/concept-insights/api/v2/graphs/wikipedia/en-20120601' 171 | base_url += '/concepts/' + s_label + '/relation_scores?concepts=[' 172 | for t_label in list_of_target_labels: 173 | base_url += '"/graphs/wikipedia/en-20120601/concepts/' + t_label + '",' 174 | base_url = base_url[:-1] + ']' 175 | r = requests.get(base_url, headers=headers) 176 | r.raise_for_status() 177 | return json.loads(r.text) 178 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # watsongraph documentation build configuration file, created by 5 | # sphinx-quickstart on Tue Jan 19 17:56:01 2016. 6 | # 7 | # This file is execfile()d with the current directory set to its 8 | # containing dir. 9 | # 10 | # Note that not all possible configuration values are present in this 11 | # autogenerated file. 12 | # 13 | # All configuration values have a default; values that are commented out 14 | # serve to show the default. 15 | 16 | import sys 17 | import os 18 | 19 | 20 | # If extensions (or modules to document with autodoc) are in another directory, 21 | # add these directories to sys.path here. If the directory is relative to the 22 | # documentation root, use os.path.abspath to make it absolute, like shown here. 23 | sys.path.insert(0, os.path.abspath('..') + "/watsongraph") 24 | 25 | # -- General configuration ------------------------------------------------ 26 | 27 | # If your documentation needs a minimal Sphinx version, state it here. 28 | #needs_sphinx = '1.0' 29 | 30 | # Add any Sphinx extension module names here, as strings. They can be 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32 | # ones. 33 | extensions = [ 34 | 'sphinx.ext.autodoc', 35 | ] 36 | 37 | # Add any paths that contain templates here, relative to this directory. 38 | templates_path = ['_templates'] 39 | 40 | # The suffix(es) of source filenames. 41 | # You can specify multiple suffix as a list of string: 42 | # source_parsers = { 43 | # '.md': CommonMarkParser, 44 | # } 45 | 46 | source_suffix = ['.rst'] 47 | # source_suffix = ['.rst', '.md'] 48 | 49 | # The encoding of source files. 50 | #source_encoding = 'utf-8-sig' 51 | 52 | # The master toctree document. 53 | master_doc = 'index' 54 | 55 | # General information about the project. 56 | project = 'watsongraph' 57 | copyright = '2016, Aleksey Bilogur' 58 | author = 'Aleksey Bilogur' 59 | 60 | # The version info for the project you're documenting, acts as replacement for 61 | # |version| and |release|, also used in various other places throughout the 62 | # built documents. 63 | # 64 | # The short X.Y version. 65 | version = '0.2.2' 66 | # The full version, including alpha/beta/rc tags. 67 | release = '0.2.2' 68 | 69 | # The language for content autogenerated by Sphinx. Refer to documentation 70 | # for a list of supported languages. 71 | # 72 | # This is also used if you do content translation via gettext catalogs. 73 | # Usually you set "language" from the command line for these cases. 74 | language = None 75 | 76 | # There are two options for replacing |today|: either, you set today to some 77 | # non-false value, then it is used: 78 | #today = '' 79 | # Else, today_fmt is used as the format for a strftime call. 80 | #today_fmt = '%B %d, %Y' 81 | 82 | # List of patterns, relative to source directory, that match files and 83 | # directories to ignore when looking for source files. 84 | exclude_patterns = ['_build'] 85 | 86 | # The reST default role (used for this markup: `text`) to use for all 87 | # documents. 88 | #default_role = None 89 | 90 | # If true, '()' will be appended to :func: etc. cross-reference text. 91 | #add_function_parentheses = True 92 | 93 | # If true, the current module name will be prepended to all description 94 | # unit titles (such as .. function::). 95 | #add_module_names = True 96 | 97 | # If true, sectionauthor and moduleauthor directives will be shown in the 98 | # output. They are ignored by default. 99 | #show_authors = False 100 | 101 | # The name of the Pygments (syntax highlighting) style to use. 102 | pygments_style = 'sphinx' 103 | 104 | # A list of ignored prefixes for module index sorting. 105 | #modindex_common_prefix = [] 106 | 107 | # If true, keep warnings as "system message" paragraphs in the built documents. 108 | #keep_warnings = False 109 | 110 | # If true, `todo` and `todoList` produce output, else they produce nothing. 111 | todo_include_todos = False 112 | 113 | 114 | # -- Options for HTML output ---------------------------------------------- 115 | 116 | # The theme to use for HTML and HTML Help pages. See the documentation for 117 | # a list of builtin themes. 118 | html_theme = 'alabaster' 119 | 120 | # Theme options are theme-specific and customize the look and feel of a theme 121 | # further. For a list of options available for each theme, see the 122 | # documentation. 123 | #html_theme_options = {} 124 | 125 | # Add any paths that contain custom themes here, relative to this directory. 126 | #html_theme_path = [] 127 | 128 | # The name for this set of Sphinx documents. If None, it defaults to 129 | # "
|
78 |
|
96 |
|
106 |
|
134 |
|
148 |
|
158 |
|
176 |
|
190 |
|
200 |
|
206 |
|
224 |
|
238 |
|
258 |
|
264 |
|
274 |
|
280 |
|
290 |
|
300 |
|
306 |
|
320 |
|
330 |
|
346 |
|
360 |
|
366 |
\ 746 | <%username%>\ 747 | \ 748 | <%time.delta%>\ 749 |
\ 750 |\ 752 | \ 753 | reply ▿\ 754 | proposal ▹\ 755 | \ 756 | \ 757 | \ 760 |
\ 761 |\ 762 | <#proposal_diff#>\ 763 |\ 764 |
\ 689 | Sort by:\ 690 | best rated\ 691 | newest\ 692 | oldest\ 693 |
\ 694 |\ 698 |
Add a comment\ 700 | (markup):
\ 701 |``code``, \ 704 | code blocks:::and an indented block after blank line