Skip to content
This repository was archived by the owner on Sep 1, 2021. It is now read-only.

Commit 0cdae2c

Browse files
authored
Merge pull request #19 from swiftype/acrewdson/README-fixes
Fix a few formatting things in the README; fix CI
2 parents 9ef4ce6 + b8ca008 commit 0cdae2c

File tree

3 files changed

+10
-19
lines changed

3 files changed

+10
-19
lines changed

.circleci/config.yml

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,7 @@ version: 2
66
jobs:
77
build:
88
docker:
9-
# specify the version you desire here
10-
# use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
11-
- image: circleci/python:3.6.1
12-
13-
# Specify service dependencies here if necessary
14-
# CircleCI maintains a library of pre-built images
15-
# documented at https://circleci.com/docs/2.0/circleci-images/
16-
# - image: circleci/postgres:9.4
9+
- image: circleci/python:3.7.3
1710

1811
working_directory: ~/repo
1912

@@ -39,11 +32,6 @@ jobs:
3932
- ./venv
4033
key: v1-dependencies-{{ checksum "requirements.txt" }}
4134

42-
# run tests!
43-
# this example uses Django's built-in test-runner
44-
# other common Python testing frameworks include pytest and nose
45-
# https://pytest.org
46-
# https://nose.readthedocs.io
4735
- run:
4836
name: run tests
4937
command: |

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,14 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
5454

5555
```python
5656
>>> from swiftype_app_search import Client
57-
>>> client = Client(api_key='private-mu75psc5egt9ppzuycnc2mc3', base_endpoint='localhost:3002/api/as/v1', use_https=False)
57+
>>> client = Client(
58+
api_key='private-mu75psc5egt9ppzuycnc2mc3',
59+
base_endpoint='localhost:3002/api/as/v1',
60+
use_https=False
61+
)
5862
```
5963

60-
### Index multiple document
64+
### Indexing: Creating or Updating a Single Document
6165

6266
```python
6367
>>> engine_name = 'favorite-videos'
@@ -71,7 +75,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
7175
{'id': 'INscMGmhmX4'}
7276
```
7377

74-
### Index documents
78+
### Indexing: Creating or Updating Multiple Documents
7579

7680
```python
7781
>>> engine_name = 'favorite-videos'
@@ -179,7 +183,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
179183
{'deleted': True}
180184
```
181185

182-
### Running search
186+
### Searching
183187

184188
```python
185189
>>> client.search('favorite-videos', 'grumpy cat', {})
@@ -253,7 +257,7 @@ You can checkout the [Elastic App Search community discuss forums](https://discu
253257

254258
## Contribute 🚀
255259

256-
We welcome contributors to the project. Before you begin, a couple notes...
260+
We welcome contributors to the project. Before you begin, a couple notes:
257261

258262
+ 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).
259263
+ Please write simple code and concise documentation, when appropriate.

setup.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
'PyJWT'
4242
],
4343
tests_require=[
44-
'mock',
4544
'requests_mock',
4645
'future'
4746
],

0 commit comments

Comments
 (0)