renamed all twittersearch -> searchtweets

Aaron Gonzales · Aaron Gonzales · commit e6b872da55b1 · 2018-01-08T11:41:09.000-07:00
diff --git a/README.rst b/README.rst
@@ -181,7 +181,7 @@ throughout your program's session.
 
 .. code:: python
 
-    from twittersearch import ResultStream, gen_rule_payload, load_credentials
+    from searchtweets import ResultStream, gen_rule_payload, load_credentials
 
 Enterprise setup
 ----------------
@@ -257,7 +257,7 @@ Let's see how it goes:
 
 .. code:: python
 
-    from twittersearch import collect_results
+    from searchtweets import collect_results
 
 .. code:: python
 
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = twittersearchapi
+SPHINXPROJ    = searchtweetsapi
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -55,7 +55,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'twitter search api'
+project = 'Twitter Search APIs Python Wrapper'
 copyright = '2017, twitterdev'
 author = 'twitterdev'
 
@@ -112,7 +112,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'twittersearchdoc'
+htmlhelp_basename = 'searchtweetsdoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -139,7 +139,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'twittersearch.tex', 'twitter search api Documentation',
+    (master_doc, 'searchtweets.tex', 'twitter search api Documentation',
      'twitterdev', 'manual'),
 ]
 
@@ -149,7 +149,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'twittersearch', 'twitter search api Documentation',
+    (master_doc, 'searchtweets', 'twitter search api Documentation',
      [author], 1)
 ]
 
@@ -160,8 +160,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'twittersearch', 'twitter search api Documentation',
-     author, 'twittersearch', 'One line description of project.',
+    (master_doc, 'searchtweets', 'twitter search api Documentation',
+     author, 'searchtweets', 'One line description of project.',
      'Miscellaneous'),
 ]
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,7 +11,7 @@
    :caption: Contents:
 
    self
-   twittersearch
+   searchtweets
 
 
 
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,7 +1,7 @@
-twittersearch
+searchtweets
 =============
 
 .. toctree::
    :maxdepth: 4
 
-   twittersearch
+   searchtweets
diff --git a/docs/source/twittersearch.rst b/docs/source/twittersearch.rst
@@ -1,29 +1,29 @@
-twittersearch package
+searchtweets package
 =====================
 
 Submodules
 ----------
 
-twittersearch\.api\_utils module
+searchtweets\.api\_utils module
 --------------------------------
 
-.. automodule:: twittersearch.api_utils
+.. automodule:: searchtweets.api_utils
     :members:
     :undoc-members:
     :show-inheritance:
 
-twittersearch\.result\_stream module
+searchtweets\.result\_stream module
 ------------------------------------
 
-.. automodule:: twittersearch.result_stream
+.. automodule:: searchtweets.result_stream
     :members:
     :undoc-members:
     :show-inheritance:
 
-twittersearch\.utils module
+searchtweets\.utils module
 ---------------------------
 
-.. automodule:: twittersearch.utils
+.. automodule:: searchtweets.utils
     :members:
     :undoc-members:
     :show-inheritance:
@@ -32,7 +32,7 @@ twittersearch\.utils module
 Module contents
 ---------------
 
-.. automodule:: twittersearch
+.. automodule:: searchtweets
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/examples/api_example.ipynb b/examples/api_example.ipynb
@@ -41,7 +41,7 @@
    },
    "outputs": [],
    "source": [
-    "from twittersearch import ResultStream, gen_rule_payload, load_credentials"
+    "from searchtweets import ResultStream, gen_rule_payload, load_credentials"
    ]
   },
   {
@@ -149,7 +149,7 @@
    },
    "outputs": [],
    "source": [
-    "from twittersearch import collect_results"
+    "from searchtweets import collect_results"
    ]
   },
   {
diff --git a/examples/readme.rst b/examples/readme.rst
@@ -41,7 +41,7 @@ throughout your program's session.
 
 .. code:: python
 
-    from twittersearch import ResultStream, gen_rule_payload, load_credentials
+    from searchtweets import ResultStream, gen_rule_payload, load_credentials
 
 Enterprise setup
 ----------------
@@ -117,7 +117,7 @@ Let's see how it goes:
 
 .. code:: python
 
-    from twittersearch import collect_results
+    from searchtweets import collect_results
 
 .. code:: python
 
diff --git a/searchtweets/__init__.py b/searchtweets/__init__.py
diff --git a/searchtweets/api_utils.py b/searchtweets/api_utils.py
@@ -65,7 +65,7 @@ def convert_utc_time(datetime_str):
         string of GNIP API formatted date.
 
     Example:
-        >>> from twittersearch.utils import convert_utc_time
+        >>> from searchtweets.utils import convert_utc_time
         >>> convert_utc_time("201708020000")
         '201708020000'
         >>> convert_utc_time("2017-08-02")
@@ -136,7 +136,7 @@ def gen_rule_payload(pt_rule, results_per_call=500,
 
     Example:
 
-        >>> from twittersearch.utils import gen_rule_payload
+        >>> from searchtweets.utils import gen_rule_payload
         >>> gen_rule_payload("kanye west has:geo",
             ...              from_date="2017-08-21",
             ...              to_date="2017-08-22")
@@ -243,7 +243,7 @@ def load_credentials(filename=None, account_type=None):
     Returns: dict of your access credentials.
 
     Example:
-    >>> from twittersearch.api_utils import load_credentials
+    >>> from searchtweets.api_utils import load_credentials
     >>> search_args = load_credentials(account_type="premium")
     >>> search_args.keys()
     dict_keys(['bearer_token', 'endpoint'])
diff --git a/searchtweets/result_stream.py b/searchtweets/result_stream.py
@@ -16,8 +16,11 @@
     import json
 from tweet_parser.tweet import Tweet
 
-from .utils import *
-from .api_utils import *
+from .utils import merge_dicts
+
+from .api_utils import (infer_endpoint, GNIP_RESP_CODES,
+                        change_to_count_endpoint)
+
 
 logger = logging.getLogger(__name__)
 
@@ -278,7 +281,7 @@ def collect_results(rule, max_results=500, result_stream_args=None):
         list of results
 
     Example:
-        >>> from twittersearch import collect_results
+        >>> from searchtweets import collect_results
         >>> tweets = collect_results(rule,
                                      max_results=500,
                                      result_stream_args=search_args)
diff --git a/searchtweets/utils.py b/searchtweets/utils.py
@@ -22,7 +22,12 @@
 
 
 def take(n, iterable):
-    "Return first n items of the iterable as a list"
+    """Return first n items of the iterable as a list
+    
+    Args:
+        n (int): number of items to return
+        iterable (iterable): the object to select
+    """
     return it.islice(iterable, n)
 
 
@@ -31,7 +36,7 @@ def partition(iterable, chunk_size, pad_none=False):
     certain chunk size, padding with Nones if availble.
 
     Example:
-        >>> from twittersearch.utils import partition
+        >>> from searchtweets.utils import partition
         >>> iter_ = range(10)
         >>> list(partition(iter_, 3))
         [(0, 1, 2), (3, 4, 5), (6, 7, 8)]
@@ -58,7 +63,7 @@ def merge_dicts(*dicts):
         the sequence will override duplicate keys from previous dictionaries.
 
     Example:
-        >>> from twittersearch.utils import merge_dicts
+        >>> from searchtweets.utils import merge_dicts
         >>> d1 = {"rule": "something has:geo"}
         >>> d2 = {"maxResults": 1000}
         >>> merge_dicts(*[d1, d2])
diff --git a/setup.py b/setup.py
@@ -1,14 +1,14 @@
 from setuptools import setup, find_packages
 
-setup(name='twittersearch',
+setup(name='searchtweets',
       description="Wrapper for Twitter's Premium and Enterprise search APIs",
       url='https://github.com/twitterdev/twitter_search_api',
       author='Fiona Pigott, Jeff Kolb, Josh Montague, Aaron Gonzales',
       long_description=open('README.rst', 'r').read(),
       author_email='agonzales@twitter.com',
       license='MIT',
-      version='0.1.3',
+      version='1.0',
       install_requires=["requests", "tweet_parser", "pyyaml"],
       packages=find_packages(),
-      scripts=["tools/twitter_search.py"],
+      scripts=["tools/search_tweets.py"],
       )
diff --git a/tools/search_tweets.py b/tools/search_tweets.py
@@ -3,9 +3,9 @@
 import json
 import sys
 import logging
-from twittersearch.result_stream import ResultStream
-from twittersearch.api_utils import *
-from twittersearch.utils import *
+from searchtweets.result_stream import ResultStream
+from searchtweets.api_utils import *
+from searchtweets.utils import *
 
 logger = logging.getLogger()
 # we want to leave this here and have it command-line configurable via the

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`},`
`42`	`42`	`"outputs": [],`
`43`	`43`	`"source": [`
`44`		`- "from twittersearch import ResultStream, gen_rule_payload, load_credentials"`
	`44`	`+ "from searchtweets import ResultStream, gen_rule_payload, load_credentials"`
`45`	`45`	`]`
`46`	`46`	`},`
`47`	`47`	`{`
`@@ -149,7 +149,7 @@`
`149`	`149`	`},`
`150`	`150`	`"outputs": [],`
`151`	`151`	`"source": [`
`152`		`- "from twittersearch import collect_results"`
	`152`	`+ "from searchtweets import collect_results"`
`153`	`153`	`]`
`154`	`154`	`},`
`155`	`155`	`{`