changed from flashtext.keyword import KeywordProcessor to from flasht…

…ext import KeywordProcessor
d0tN3t · Oct 27, 2017 · 9f15189 · 9f15189
1 parent e80655b
commit 9f15189
Show file tree

Hide file tree

Showing 14 changed files with 43 additions and 28 deletions.
diff --git a/README.rst b/README.rst
@@ -43,7 +43,7 @@ Documentation can be found at `FlashText Read the Docs
 Usage
 -----
 Extract keywords
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> # keyword_processor.add_keyword(<unclean name>, <standardised name>)
     >>> keyword_processor.add_keyword('Big Apple', 'New York')
@@ -59,7 +59,7 @@ Replace keywords
     >>> # 'I love New York and NCR region.'
 
 Case Sensitive example
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor(case_sensitive=True)
     >>> keyword_processor.add_keyword('Big Apple', 'New York')
     >>> keyword_processor.add_keyword('Bay Area')
@@ -68,7 +68,7 @@ Case Sensitive example
     >>> # ['Bay Area']
 
 No clean name for Keywords
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_processor.add_keyword('Big Apple')
     >>> keyword_processor.add_keyword('Bay Area')
@@ -77,7 +77,7 @@ No clean name for Keywords
     >>> # ['Big Apple', 'Bay Area']
 
 Add Multiple Keywords simultaneously
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_dict = {
     >>>     "java": ["java_2e", "java programing"],
@@ -91,7 +91,7 @@ Add Multiple Keywords simultaneously
     >>> # output ['product management', 'java']
 
 To Remove keywords
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_dict = {
     >>>     "java": ["java_2e", "java programing"],
@@ -110,7 +110,7 @@ To Remove keywords
 For detecting Word Boundary currently any character other than this `\\w` `[A-Za-z0-9_]` is considered a word boundary.
 
 To set or add characters as part of word characters
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_processor.add_keyword('Big Apple')
     >>> print(keyword_processor.extract_keywords('I love Big Apple/Bay Area.'))

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,4 +1,4 @@
-version: '3.3'
+version: '2.0'
 
 services:
     pytest-python2.7:
@@ -15,16 +15,30 @@ services:
         - .:/app
       working_dir: /app
 
-    pytest-python2.7/i386:
+    pytest-python3.5:
+      image: python:3.5
+      command: bash -c "pip install pytest; python setup.py test"
+      volumes:
+        - .:/app
+      working_dir: /app
+
+    pytest-python2.7-i386:
       image: i386/python:2.7
       command: bash -c "pip install pytest; python setup.py test"
       volumes:
         - .:/app
       working_dir: /app
 
-    pytest-python3.3/i386:
+    pytest-python3.3-i386:
       image: i386/python:3.3
       command: bash -c "pip install pytest; python setup.py test"
       volumes:
         - .:/app
       working_dir: /app
+
+    pytest-python3.5-i386:
+      image: i386/python:3.5
+      command: bash -c "pip install pytest; python setup.py test"
+      volumes:
+        - .:/app
+      working_dir: /app
diff --git a/docs/api.rst b/docs/api.rst
@@ -3,7 +3,7 @@ API Doc
 
 Import and initialize module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> # if match has to be case sensitive
     >>> keyword_processor = KeywordProcessor(case_sensitive=True)

diff --git a/docs/conf.py b/docs/conf.py
@@ -153,5 +153,5 @@
      'Miscellaneous'),
 ]
 
-
-
+charset_type = 'utf-8'
+charset_table = '0..9, A..Z->a..z, _, a..z, -, [, ]'
diff --git a/docs/index.rst b/docs/index.rst
@@ -40,7 +40,7 @@ Installation
 Usage
 -----
 Extract keywords
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> # keyword_processor.add_keyword(<unclean name>, <standardised name>)
     >>> keyword_processor.add_keyword('Big Apple', 'New York')
@@ -56,7 +56,7 @@ Replace keywords
     >>> # 'I love New York and NCR region.'
 
 Case Sensitive example
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor(case_sensitive=True)
     >>> keyword_processor.add_keyword('Big Apple', 'New York')
     >>> keyword_processor.add_keyword('Bay Area')
@@ -65,7 +65,7 @@ Case Sensitive example
     >>> # ['Bay Area']
 
 No clean name for Keywords
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_processor.add_keyword('Big Apple')
     >>> keyword_processor.add_keyword('Bay Area')
@@ -74,7 +74,7 @@ No clean name for Keywords
     >>> # ['Big Apple', 'Bay Area']
 
 Add Multiple Keywords simultaneously
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_dict = {
     >>>     "java": ["java_2e", "java programing"],
@@ -88,7 +88,7 @@ Add Multiple Keywords simultaneously
     >>> # output ['product management', 'java']
 
 To Remove keywords
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_dict = {
     >>>     "java": ["java_2e", "java programing"],
@@ -107,7 +107,7 @@ To Remove keywords
 For detecting Word Boundary currently any character other than this `\\w` `[A-Za-z0-9_]` is considered a word boundary.
 
 To set or add characters as part of word characters
-    >>> from flashtext.keyword import KeywordProcessor
+    >>> from flashtext import KeywordProcessor
     >>> keyword_processor = KeywordProcessor()
     >>> keyword_processor.add_keyword('Big Apple')
     >>> print(keyword_processor.extract_keywords('I love Big Apple/Bay Area.'))

diff --git a/flashtext/__init__.py b/flashtext/__init__.py
@@ -0,0 +1 @@
+from flashtext.keyword import KeywordProcessor
diff --git a/flashtext/keyword.py b/flashtext/keyword.py
@@ -17,7 +17,7 @@ class KeywordProcessor(object):
 
     Examples:
         >>> # import module
-        >>> from flashtext.keyword import KeywordProcessor
+        >>> from flashtext import KeywordProcessor
         >>> # Create an object of KeywordProcessor
         >>> keyword_processor = KeywordProcessor()
         >>> # add keywords
@@ -284,7 +284,7 @@ def extract_keywords(self, sentence):
             keywords_extracted (list(str)): List of terms/keywords found in sentence that match our corpus
 
         Examples:
-            >>> from flashtext.keyword import KeywordProcessor
+            >>> from flashtext import KeywordProcessor
             >>> keyword_processor = KeywordProcessor()
             >>> keyword_processor.add_keyword('Big Apple', 'New York')
             >>> keyword_processor.add_keyword('Bay Area')
@@ -385,7 +385,7 @@ def replace_keywords(self, sentence):
             new_sentence (str): Line of text with replaced keywords
 
         Examples:
-            >>> from flashtext.keyword import KeywordProcessor
+            >>> from flashtext import KeywordProcessor
             >>> keyword_processor = KeywordProcessor()
             >>> keyword_processor.add_keyword('Big Apple', 'New York')
             >>> keyword_processor.add_keyword('Bay Area')

diff --git a/setup.py b/setup.py
@@ -16,7 +16,7 @@ def run(self):
         raise SystemExit(errno)
 
 name = 'flashtext'
-version = '2.2'
+version = '2.3'
 
 cmdclass = {'test': PyTest}
 

diff --git a/test/test_dictionary_loading.py b/test/test_dictionary_loading.py
@@ -1,4 +1,4 @@
-from flashtext.keyword import KeywordProcessor
+from flashtext import KeywordProcessor
 import logging
 import unittest
 import json

diff --git a/test/test_extractor.py b/test/test_extractor.py
@@ -1,4 +1,4 @@
-from flashtext.keyword import KeywordProcessor
+from flashtext import KeywordProcessor
 import logging
 import unittest
 import json

diff --git a/test/test_file_load.py b/test/test_file_load.py
@@ -1,4 +1,4 @@
-from flashtext.keyword import KeywordProcessor
+from flashtext import KeywordProcessor
 import logging
 import unittest
 import json

diff --git a/test/test_loading_keyword_list.py b/test/test_loading_keyword_list.py
@@ -1,4 +1,4 @@
-from flashtext.keyword import KeywordProcessor
+from flashtext import KeywordProcessor
 import logging
 import unittest
 import json

diff --git a/test/test_remove_keywords.py b/test/test_remove_keywords.py
@@ -1,5 +1,5 @@
 from collections import defaultdict
-from flashtext.keyword import KeywordProcessor
+from flashtext import KeywordProcessor
 import logging
 import unittest
 import json

diff --git a/test/test_replacer.py b/test/test_replacer.py
@@ -1,4 +1,4 @@
-from flashtext.keyword import KeywordProcessor
+from flashtext import KeywordProcessor
 import logging
 import unittest
 import json