Skip to content

Remove Examples sections #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2020
Merged

Remove Examples sections #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 11 additions & 123 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,7 @@
- [🔧 Installation](#-installation)
- [🚀 Getting started](#-getting-started)
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
- [🎬 Examples](#-examples)
- [Indexes](#indexes)
- [Documents](#documents)
- [Update status](#update-status)
- [Search](#search)
- [🎬 Documentation and Examples](#-documentation-and-examples)
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)

## 🔧 Installation
Expand Down Expand Up @@ -79,9 +75,10 @@ documents = [
index.add_documents(documents) # => { "updateId": 0 }
```

With the `updateId`, you can check the status (`processed` or `failed`) of your documents addition thanks to this [method](#update-status).
With the `updateId`, you can check the status (`processed` or `failed`) of your documents addition thanks to this [method](https://docs.meilisearch.com/references/updates.html#get-an-update-status).

#### Search in index <!-- omit in toc -->

``` python
# MeiliSearch is typo-tolerant:
index.search('harry pottre')
Expand All @@ -107,128 +104,19 @@ This package is compatible with the following MeiliSearch versions:
- `v0.14.X`
- `v0.13.X`

## 🎬 Examples

You can check out [the API documentation](https://docs.meilisearch.com/references/).

### Indexes

#### Create an index <!-- omit in toc -->
```python
# Create an index
client.create_index('books')
# Create an index and give the primary-key
client.create_index('books', {'primaryKey': 'book_id'})
# Get an index or create it if it doesn't exist
client.get_or_create_index('books', {'primaryKey': 'book_id'})
```

#### List all indexes <!-- omit in toc -->
```python
client.get_indexes()
```

#### Get an index object <!-- omit in toc -->

```python
index = client.get_index('books')
```

### Documents

#### Fetch documents <!-- omit in toc -->

```python
# Get one document
index.get_document(123)
# Get documents by batch
index.get_documents({ 'offset': 10 , 'limit': 20 })
```

#### Add documents <!-- omit in toc -->

```python
index.add_documents([{ 'book_id': 2, 'title': 'Madame Bovary' }])
```

Response:
```json
{
"updateId": 1
}
```
This `updateId` allows you to [track the current update](#update-status).

#### Delete documents <!-- omit in toc -->

```python
# Delete one document
index.delete_document(2)
# Delete several documents
index.delete_documents([1, 42])
# Delete all documents
index.delete_all_documents()
```

### Update status

```python
# Get one update status
# Parameter: the updateId got after an asynchronous request (e.g. documents addition)
index.get_update_status(1)
# Get all updates status
index.get_all_update_status()
```

### Search
## 🎬 Documentation and Examples

#### Basic search <!-- omit in toc -->
MeiliSearch documentation provides **examples** and a detailed explanation of every one of its features and functionalities, including examples on how to implement them **using this SDK**.

```python
index.search('prince')
```

```json
{
"hits": [
{
"book_id": 456,
"title": "Le Petit Prince"
},
{
"book_id": 4,
"title": "Harry Potter and the Half-Blood Prince"
}
],
"offset": 0,
"limit": 20,
"processingTimeMs": 13,
"query": "prince"
}
```
Please read the [guides available in the documentation](https://docs.meilisearch.com/guides/) or check the [API references](https://docs.meilisearch.com/references/) to find the one that you need!

#### Custom search <!-- omit in toc -->
The following sections may interest you:

All the supported options are described in [this documentation section](https://docs.meilisearch.com/references/search.html#search-in-an-index).
- [Manipulate documents](https://docs.meilisearch.com/references/documents.html)
- [Search](https://docs.meilisearch.com/references/search.html)
- [Manage the indexes](https://docs.meilisearch.com/references/indexes.html)
- [Configure the index settings](https://docs.meilisearch.com/references/settings.html)

```python
response = index.search('prince', { 'limit': 1 })
```

```json
{
"hits": [
{
"book_id": 456,
"title": "Le Petit Prince"
}
],
"offset": 0,
"limit": 1,
"processingTimeMs": 10,
"query": "prince"
}
```
## ⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!
Expand Down