updated readme and example text

Author: Aaron Gonzales

README.rst

@@ -155,7 +155,7 @@ your authentication will be a (username, password) pair. If you are a
 premium client, you'll need to get a bearer token that will be passed
 with each call for authentication.
 
-We advocate putting your API info in a yaml file such as this:
+Your credentials should be put into a YAML file that looks like this:
 
 .. code:: .yaml
 
@@ -172,7 +172,7 @@ Premium users should only have the ``endpoint`` and ``bearer_token``;
 Enterprise customers should have ``account``, ``username``,
 ``endpoint``, and ``password``.
 
-Our credential reader will default to expecing this file in
+Our credential reader expects this file at
 ``"~/.twitter_search.yaml"``, but you can pass the relevant location as
 needed.
 
@@ -181,9 +181,6 @@ throughout your program's session.
 
 .. code:: python
 
-    import os
-    import json
-
     from twittersearch import ResultStream, gen_rule_payload, load_credentials
 
 Enterprise setup
@@ -542,19 +539,6 @@ method; please see your developer console for details.
     Setting up at @CampFlogGnaw https://t.co/nVq8QjkKsf
 
 
-.. code:: python
-
-    premium_search_args.keys()
-
-
-
-
-.. parsed-literal::
-
-    dict_keys(['bearer_token', 'endpoint'])
-
-
-
 .. code:: python
 
     rule = gen_rule_payload("from:jack",
@@ -621,4 +605,3 @@ method; please see your developer console for details.
     {'timePeriod': '201709220000', 'count': 0}
     {'timePeriod': '201709210000', 'count': 1}
     {'timePeriod': '201709200000', 'count': 7}
-

examples/api_example.ipynb

@@ -13,7 +13,7 @@
     "\n",
     "Prior to starting your program, an easy way to define your secrets will be setting an environment variable. If you are an enterprise client, your authentication will be a (username, password) pair. If you are a premium client, you'll need to get a bearer token that will be passed with each call for authentication.\n",
     "\n",
-    "We advocate putting your API info in a yaml file such as this:\n",
+    "Your credentials should be put into a YAML file that looks like this:\n",
     "\n",
     "\n",
     "```.yaml\n",
@@ -41,10 +41,6 @@
    },
    "outputs": [],
    "source": [
-    "import os\n",
-    "import json\n",
-    "from unidecode import unidecode\n",
-    "\n",
     "from twittersearch import ResultStream, gen_rule_payload, load_credentials"
    ]
   },
@@ -59,20 +55,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 42,
    "metadata": {
     "collapsed": true
    },
    "outputs": [],
-   "source": [
-    "from twittersearch import infer_endpoint"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 42,
-   "metadata": {},
-   "outputs": [],
    "source": [
     "enterprise_search_args = load_credentials(\"~/.twitter_keys.yaml\",\n",
     "                                          account_type=\"enterprise\")"
@@ -169,6 +156,7 @@
    "cell_type": "code",
    "execution_count": 46,
    "metadata": {
+    "collapsed": true,
     "scrolled": true
    },
    "outputs": [],
@@ -333,7 +321,9 @@
   {
    "cell_type": "code",
    "execution_count": 56,
-   "metadata": {},
+   "metadata": {
+    "collapsed": true
+   },
    "outputs": [],
    "source": [
     "tweets = list(rs.stream())"
@@ -401,7 +391,9 @@
   {
    "cell_type": "code",
    "execution_count": 24,
-   "metadata": {},
+   "metadata": {
+    "collapsed": true
+   },
    "outputs": [],
    "source": [
     "count_rule = gen_rule_payload(\"beyonce\", count_bucket=\"day\")\n",
@@ -541,26 +533,6 @@
     "[print(tweet.all_text) for tweet in tweets[0:10]];"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 58,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "dict_keys(['bearer_token', 'endpoint'])"
-      ]
-     },
-     "execution_count": 58,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "premium_search_args.keys()"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 37,

examples/readme.rst

@@ -15,7 +15,7 @@ your authentication will be a (username, password) pair. If you are a
 premium client, you'll need to get a bearer token that will be passed
 with each call for authentication.
 
-We advocate putting your API info in a yaml file such as this:
+Your credentials should be put into a YAML file that looks like this:
 
 .. code:: .yaml
 
@@ -32,7 +32,7 @@ Premium users should only have the ``endpoint`` and ``bearer_token``;
 Enterprise customers should have ``account``, ``username``,
 ``endpoint``, and ``password``.
 
-Our credential reader will default to expecing this file in
+Our credential reader expects this file at
 ``"~/.twitter_search.yaml"``, but you can pass the relevant location as
 needed.
 
@@ -41,10 +41,6 @@ throughout your program's session.
 
 .. code:: python
 
-    import os
-    import json
-    from unidecode import unidecode
-    
     from twittersearch import ResultStream, gen_rule_payload, load_credentials
 
 Enterprise setup
@@ -53,10 +49,6 @@ Enterprise setup
 If you are an enterprise customer, you'll need to authenticate with a
 basic username/password method. You can specify that here:
 
-.. code:: python
-
-    from twittersearch import infer_endpoint
-
 .. code:: python
 
     enterprise_search_args = load_credentials("~/.twitter_keys.yaml",
@@ -407,19 +399,6 @@ method; please see your developer console for details.
     Setting up at @CampFlogGnaw https://t.co/nVq8QjkKsf
 
 
-.. code:: python
-
-    premium_search_args.keys()
-
-
-
-
-.. parsed-literal::
-
-    dict_keys(['bearer_token', 'endpoint'])
-
-
-
 .. code:: python
 
     rule = gen_rule_payload("from:jack",