Merge pull request #19 from swiftype/acrewdson/README-fixes

Fix a few formatting things in the README; fix CI

Author: acrewdson

.circleci/config.yml

@@ -6,14 +6,7 @@ version: 2
 jobs:
   build:
     docker:
-      # specify the version you desire here
-      # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
-      - image: circleci/python:3.6.1
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
+      - image: circleci/python:3.7.3
 
     working_directory: ~/repo
 
@@ -39,11 +32,6 @@ jobs:
             - ./venv
           key: v1-dependencies-{{ checksum "requirements.txt" }}
 
-      # run tests!
-      # this example uses Django's built-in test-runner
-      # other common Python testing frameworks include pytest and nose
-      # https://pytest.org
-      # https://nose.readthedocs.io
       - run:
           name: run tests
           command: |

README.md

@@ -54,10 +54,14 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 
 ```python
 >>> from swiftype_app_search import Client
->>> client = Client(api_key='private-mu75psc5egt9ppzuycnc2mc3', base_endpoint='localhost:3002/api/as/v1', use_https=False)
+>>> client = Client(
+    api_key='private-mu75psc5egt9ppzuycnc2mc3',
+    base_endpoint='localhost:3002/api/as/v1',
+    use_https=False
+)
 ```
 
-### Index multiple document
+### Indexing: Creating or Updating a Single Document
 
 ```python
 >>> engine_name = 'favorite-videos'
@@ -71,7 +75,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 {'id': 'INscMGmhmX4'}
 ```
 
-### Index documents
+### Indexing: Creating or Updating Multiple Documents
 
 ```python
 >>> engine_name = 'favorite-videos'
@@ -179,7 +183,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 {'deleted': True}
 ```
 
-### Running search
+### Searching
 
 ```python
 >>> client.search('favorite-videos', 'grumpy cat', {})
@@ -253,7 +257,7 @@ You can checkout the [Elastic App Search community discuss forums](https://discu
 
 ## Contribute 🚀
 
-We welcome contributors to the project. Before you begin, a couple notes...
+We welcome contributors to the project. Before you begin, a couple notes:
 
 + Prior to opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/swiftype/swiftype-app-search-python/issues).
 + Please write simple code and concise documentation, when appropriate.

setup.py

@@ -41,7 +41,6 @@
         'PyJWT'
     ],
     tests_require=[
-        'mock',
         'requests_mock',
         'future'
     ],