Skip to content

Commit b61d8bd

Browse files
committed
Remove most of the reference to Swiftype in the README.
1 parent cad2c13 commit b61d8bd

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<p align="center"><img src="https://github.com/swiftype/swiftype-py/blob/master/logo-site-search.png?raw=true" alt="Elastic Site Search Logo"></p>
1+
<p align="center"><img src="https://github.com/elastic/site-search-python/blob/master/logo-site-search.png?raw=true" alt="Elastic Site Search Logo"></p>
22

3-
<p align="center"><a href="https://travis-ci.org/swiftype/swiftype-py"><img src="https://travis-ci.org/swiftype/swiftype-py.png?branch=master" alt="Travis build"></a>
4-
<a href="https://github.com/swiftype/swiftype-py/releases"><img src="https://img.shields.io/github/release/swiftype/swiftype-py/all.svg?style=flat-square" alt="GitHub release" /></a></p>
3+
<p align="center"><a href="https://travis-ci.org/elastic/site-search-python"><img src="https://travis-ci.org/elastic/site-search-python.png?branch=master" alt="Travis build"></a>
4+
<a href="https://github.com/elastic/site-search-python/releases"><img src="https://img.shields.io/github/release/elastic/site-search-python/all.svg?style=flat-square" alt="GitHub release" /></a></p>
55

66
> A first-party Python client for the [Elastic Site Search API](https://swiftype.com/documentation/site-search/overview).
77
@@ -18,7 +18,7 @@
1818

1919
## Getting started 🐣
2020

21-
You can install the latest version of the Swiftype client using `pip`:
21+
You can install the latest version of the Elastic Site Search client using `pip`:
2222

2323
```bash
2424
pip install elastic-site-search
@@ -34,7 +34,7 @@ To install locally, clone this repository, `cd` into the directory and run:
3434
3535
## Usage
3636

37-
1. Create an account at [Swiftype](https://swiftype.com/) and get your API key from your [Account Settings](https://app.swiftype.com/settings/account).
37+
1. Create [Elastic Site Search account](https://swiftype.com/) and get your API key from your [Account Settings](https://app.swiftype.com/settings/account).
3838

3939
2. Configure your client:
4040

@@ -66,8 +66,8 @@ Add a `Document` to the `videos` `DocumentType`:
6666
client.create_document('youtube', 'videos', {
6767
'external_id': 'external_id1',
6868
'fields': [
69-
{'name': 'title', 'value': 'Swiftype Demo', 'type': 'string'},
70-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search'], 'type': 'string'},
69+
{'name': 'title', 'value': 'Site Search Demo', 'type': 'string'},
70+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search'], 'type': 'string'},
7171
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=pITuOcGgpBs', 'type': 'enum'},
7272
{'name': 'category', 'value': ['Tutorial', 'Product'], 'type': 'enum'},
7373
{'name': 'publication_date', 'value': '2012-05-08T12:07Z', 'type': 'date'},
@@ -83,8 +83,8 @@ Add a `Document` to the `channels` `DocumentType`:
8383
client.create_document('youtube', 'channels', {
8484
'external_id': 'external_id1',
8585
'fields': [
86-
{'name': 'title', 'value': 'Swiftype', 'type': 'string'},
87-
{'name': 'url', 'value': 'http://www.youtube.com/user/swiftype', 'type': 'enum'},
86+
{'name': 'title', 'value': 'Elastic', 'type': 'string'},
87+
{'name': 'url', 'value': 'http://www.youtube.com/user/elasticsearch', 'type': 'enum'},
8888
{'name': 'video_views', 'value': 15678, 'type': 'integer'},
8989
{'name': 'video_counts', 'value': 6, 'type': 'integer'}
9090
]
@@ -96,28 +96,28 @@ Add a `Document` to the `channels` `DocumentType`:
9696
Now your `Engine` is ready to receive queries. By default, search queries will match any fields that are of type `string` or `text`. You can search each `DocumentType` individually:
9797

9898
```python
99-
video_results = client.search_document_type('youtube', 'videos', 'swiftype')
100-
channel_results = client.search_document_type('youtube', 'channels', 'swiftype')
99+
video_results = client.search_document_type('youtube', 'videos', 'site search')
100+
channel_results = client.search_document_type('youtube', 'channels', 'site search')
101101
```
102102

103103
or search all `DocumentType`s on your `Engine` at once:
104104

105105
```python
106-
results = client.search('youtube', 'swiftype')
106+
results = client.search('youtube', 'site search')
107107
```
108108

109109
### Autocomplete
110110

111111
Finally, as with full-text searches, you may perform autocomplete-style (prefix match) searches as well:
112112

113113
```python
114-
results = client.suggest('youtube', 'swi')
114+
results = client.suggest('youtube', 'sit')
115115
```
116116

117117
or
118118

119119
```python
120-
results = client.suggest_document_type('youtube', 'videos', 'swi')
120+
results = client.suggest_document_type('youtube', 'videos', 'sit')
121121
```
122122

123123
## API Documentation
@@ -135,42 +135,42 @@ You can find your API key in your [Account Settings](https://swiftype.com/user/e
135135

136136
### Search
137137

138-
If you want to search for e.g. `swiftype` on your `Engine`, you can use:
138+
If you want to search for e.g. `site search` on your `Engine`, you can use:
139139

140140
```python
141-
results = client.search('youtube', 'swiftype')
141+
results = client.search('youtube', 'site search')
142142
```
143143

144144
To limit the search to only the `videos` DocumentType:
145145

146146
```python
147-
results = client.search_document_type('youtube', 'videos', 'swiftype')
147+
results = client.search_document_type('youtube', 'videos', 'site search')
148148
```
149149

150150
Both search methods allow you to specify options as an extra parameter to e.g. filter or sort on fields. For more details on these options please have a look at the [Search Options](https://swiftype.com/documentation/searching). Here is an example for showing only `videos` that are in the `category` `Tutorial`:
151151

152152
```python
153-
results = client.search_document_type('youtube', 'videos', 'swiftype', {'filters': {'videos': {'category': 'Tutorial'}}})
153+
results = client.search_document_type('youtube', 'videos', 'site search', {'filters': {'videos': {'category': 'Tutorial'}}})
154154
```
155155

156156
### Autocomplete
157157

158158
Autocompletes have the same functionality as searches. You can autocomplete using all documents:
159159

160160
```python
161-
results = client.suggest('youtube', 'swi')
161+
results = client.suggest('youtube', 'sit')
162162
```
163163

164164
or just for one DocumentType:
165165

166166
```python
167-
results = client.suggest_document_type('youtube', 'videos', 'swi')
167+
results = client.suggest_document_type('youtube', 'videos', 'sit')
168168
```
169169

170170
or add options to have more control over the results:
171171

172172
```python
173-
results = client.suggest('youtube', 'swi', {'sort_field': {'videos': 'likes'}})
173+
results = client.suggest('youtube', 'sit', {'sort_field': {'videos': 'likes'}})
174174
```
175175

176176
### Engines
@@ -251,8 +251,8 @@ Create a new `Document` with mandatory `external_id` and user-defined fields:
251251
document = client.create_document('youtube', 'videos', {
252252
'external_id': 'external_id1',
253253
'fields': [
254-
{'name': 'title', 'value': 'Swiftype Demo', 'type': 'string'},
255-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search'], 'type': 'string'},
254+
{'name': 'title', 'value': 'Site Search Demo', 'type': 'string'},
255+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search'], 'type': 'string'},
256256
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=pITuOcGgpBs', 'type': 'enum'},
257257
{'name': 'category', 'value': ['Tutorial', 'Product'], 'type': 'enum'},
258258
{'name': 'publication_date', 'value': '2012-05-08T12:07Z', 'type': 'date'},
@@ -269,8 +269,8 @@ Create multiple `Document`s at once and return status for each `Document` creati
269269
{
270270
'external_id': 'external_id1',
271271
'fields': [
272-
{'name': 'title', 'value': 'Swiftype Demo', 'type': 'string'},
273-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search'], 'type': 'string'},
272+
{'name': 'title', 'value': 'Site Search Demo', 'type': 'string'},
273+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search'], 'type': 'string'},
274274
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=pITuOcGgpBs', 'type': 'enum'},
275275
{'name': 'category', 'value': ['Tutorial', 'Product'], 'type': 'enum'},
276276
{'name': 'publication_date', 'value': '2012-05-08T12:07Z', 'type': 'date'},
@@ -281,8 +281,8 @@ Create multiple `Document`s at once and return status for each `Document` creati
281281
{
282282
'external_id': 'external_id2',
283283
'fields': [
284-
{'name': 'title', 'value': 'Swiftype Search Wordpress Plugin Demo', 'type': 'string'},
285-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'WordPress'], 'type': 'string'},
284+
{'name': 'title', 'value': 'Site Search Search Wordpress Plugin Demo', 'type': 'string'},
285+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search', 'WordPress'], 'type': 'string'},
286286
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=rukXYKEpvS4', 'type': 'enum'},
287287
{'name': 'category', 'value': ['Tutorial', 'Wordpress'], 'type': 'enum'},
288288
{'name': 'publication_date', 'value': '2012-08-15T09:07Z', 'type': 'date'},
@@ -314,8 +314,8 @@ Create or update a `Document`:
314314
document = client.create_or_update_document('youtube', 'videos', {
315315
'external_id': 'external_id3',
316316
'fields': [
317-
{'name': 'title', 'value': 'Swiftype Install Type 1: Show results in an overlay', 'type': 'string'},
318-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'Web'], 'type': 'string'},
317+
{'name': 'title', 'value': 'Site Search Install Type 1: Show results in an overlay', 'type': 'string'},
318+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search', 'Web'], 'type': 'string'},
319319
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=mj2ApIx3frs', 'type': 'enum'}
320320
]
321321
})
@@ -328,16 +328,16 @@ Create or update multiple `Documents` at once:
328328
{
329329
'external_id': 'external_id4',
330330
'fields': [
331-
{'name': 'title', 'value': 'Swiftype Install Type 2: Show results on the current page', 'type': 'string'},
332-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'Web'], 'type': 'string'},
331+
{'name': 'title', 'value': 'Site Search Install Type 2: Show results on the current page', 'type': 'string'},
332+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search', 'Web'], 'type': 'string'},
333333
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=6uaZXYK2WOE', 'type': 'enum'}
334334
]
335335
},
336336
{
337337
'external_id': 'external_id5',
338338
'fields': [
339-
{'name': 'title', 'value': 'Swiftype Install Type 3: Show results on a new page', 'type': 'string'},
340-
{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'Web'], 'type': 'string'},
339+
{'name': 'title', 'value': 'Site Search Install Type 3: Show results on a new page', 'type': 'string'},
340+
{'name': 'tags', 'value': ['Site Search', 'Search', 'Full text search', 'Web'], 'type': 'string'},
341341
{'name': 'url', 'value': 'http://www.youtube.com/watch?v=ebSWAscBPtc', 'type': 'enum'}
342342
]
343343
}
@@ -369,10 +369,10 @@ Retrieve a specific `Domain` by `id`:
369369
domain = client.domain('websites', 'generated_id')
370370
```
371371

372-
Create a new `Domain` with the URL `https://swiftype.com` and start crawling:
372+
Create a new `Domain` with the URL `https://elastic.co` and start crawling:
373373

374374
```python
375-
domain = client.create_domain('websites', 'https://swiftype.com')
375+
domain = client.create_domain('websites', 'https://elastic.co')
376376
```
377377

378378
Delete a `Domain` using its `id`:
@@ -390,7 +390,7 @@ Initiate a recrawl of a specific `Domain` using its `id`:
390390
Add or update a URL for a `Domain`:
391391

392392
```python
393-
client.crawl_url('websites', 'generated_id', 'https://swiftype.com/new/path/about.html')
393+
client.crawl_url('websites', 'generated_id', 'https://elastic.co/new/path/about.html')
394394
```
395395

396396
### Analytics
@@ -451,14 +451,14 @@ You can also specify a date range for no result queries:
451451

452452
```bash
453453
pip install -r test_requirements.txt
454-
python tests/test_swiftype.py
454+
python tests/test_client.py
455455
```
456456

457457
## FAQ 🔮
458458

459459
### Where do I report issues with the client?
460460

461-
If something is not working as expected, please open an [issue](https://github.com/swiftype/swiftype-py/issues/new).
461+
If something is not working as expected, please open an [issue](https://github.com/elastic/site-search-python/issues/new).
462462

463463
### Where can I learn more about Site Search?
464464

@@ -472,7 +472,7 @@ You can checkout the [Elastic Site Search community discuss forums](https://disc
472472

473473
We welcome contributors to the project. Before you begin, a couple notes...
474474

475-
+ Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/swiftype/swiftype-py/issues).
475+
+ Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/site-search-python/issues).
476476
+ Please write simple code and concise documentation, when appropriate.
477477

478478
## License 📗

0 commit comments

Comments
 (0)