Skip to content

Commit 96e1acd

Browse files
anakin87anakin87
authored
chore: standardize readmes - part 2 (#2205)
* chore: standardize readmes - part 2 * small fix * rm leftover
1 parent f60ec4c commit 96e1acd

File tree

33 files changed

+179
-1098
lines changed

33 files changed

+179
-1098
lines changed

‎integrations/amazon_bedrock/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
- [Integration page](https://haystack.deepset.ai/integrations/amazon-bedrock)
77
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/amazon_bedrock/CHANGELOG.md)
8-
-----
8+
---
99

1010
## Contributing
1111

‎integrations/amazon_sagemaker/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
- [Integration page](https://haystack.deepset.ai/integrations/amazon-sagemaker)
77
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/amazon_sagemaker/CHANGELOG.md)
8-
-----
8+
---
99

1010
## Contributing
1111

‎integrations/anthropic/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
- [Integration page](https://haystack.deepset.ai/integrations/anthropic)
77
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/anthropic/CHANGELOG.md)
8-
-----
8+
---
99

1010
## Contributing
1111

‎integrations/cohere/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- [Integration page](https://haystack.deepset.ai/integrations/cohere)
77
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/cohere/CHANGELOG.md)
88

9-
-----
9+
---
1010

1111

1212
---

‎integrations/elasticsearch/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
1414

1515
To run integration tests locally, you need a Docker container running ElasticSearch.
16-
Use the provided `docker-compose.yml` file to start the container: `docker compose up`.
16+
Use the provided `docker-compose.yml` file to start the container: `docker compose up -d`.

‎integrations/github/README.md‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,10 @@
33
[![PyPI - Version](https://img.shields.io/pypi/v/github-haystack.svg)](https://pypi.org/project/github-haystack)
44
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/github-haystack.svg)](https://pypi.org/project/github-haystack)
55

6-
-----
6+
- [Integration page](https://haystack.deepset.ai/integrations/github)
7+
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/github/CHANGELOG.md)
8+
9+
---
10+
## Contributing
711

8-
## Table of Contents
9-
10-
- [Installation](#installation)
11-
- [License](#license)
12-
13-
## Installation
14-
15-
```console
16-
pip install github-haystack
17-
```
18-
19-
## License
20-
21-
`github-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
12+
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

‎integrations/google_ai/README.md‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,12 @@
33
[![PyPI - Version](https://img.shields.io/pypi/v/google-ai-haystack.svg)](https://pypi.org/project/google-ai-haystack)
44
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/google-ai-haystack.svg)](https://pypi.org/project/google-ai-haystack)
55

6-
---
7-
8-
**Table of Contents**
9-
10-
- [Installation](#installation)
11-
- [License](#license)
6+
- [Integration page](https://haystack.deepset.ai/integrations/google-ai)
7+
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/google_ai/CHANGELOG.md)
128

13-
## Installation
14-
15-
```console
16-
pip install google-ai-haystack
17-
```
9+
---
10+
## Contributing
1811

19-
## License
12+
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
2013

21-
`google-ai-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
14+
To run integration tests locally, you need to export the `GOOGLE_API_KEY` environment variable.

‎integrations/google_genai/README.md‎

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,61 +3,13 @@
33
[![PyPI - Version](https://img.shields.io/pypi/v/google-genai-haystack.svg)](https://pypi.org/project/google-genai-haystack)
44
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/google-genai-haystack.svg)](https://pypi.org/project/google-genai-haystack)
55

6-
-----
6+
- [Integration page](https://haystack.deepset.ai/integrations/google-genai)
7+
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/google_genai/CHANGELOG.md)
78

8-
**Table of Contents**
9+
---
910

10-
- [Installation](#installation)
11-
- [Usage](#usage)
12-
- [License](#license)
11+
## Contributing
1312

14-
## Installation
13+
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
1514

16-
```console
17-
pip install google-genai-haystack
18-
```
19-
20-
## Usage
21-
22-
This integration provides components to use Google's Gemini models via the new Google Gen AI SDK.
23-
24-
### Chat Generator
25-
26-
```python
27-
from haystack.dataclasses.chat_message import ChatMessage
28-
from haystack_integrations.components.generators.google_genai import GoogleGenAIChatGenerator
29-
30-
# Initialize the chat generator
31-
chat_generator = GoogleGenAIChatGenerator(model="gemini-2.0-flash")
32-
33-
# Generate a response
34-
messages = [ChatMessage.from_user("Tell me about the future of AI")]
35-
response = chat_generator.run(messages=messages)
36-
print(response["replies"][0].text)
37-
```
38-
39-
### Streaming Chat Generator
40-
41-
```python
42-
from haystack.dataclasses.chat_message import ChatMessage
43-
from haystack.dataclasses import StreamingChunk
44-
from haystack_integrations.components.generators.google_genai import GoogleGenAIChatGenerator
45-
46-
def streaming_callback(chunk: StreamingChunk):
47-
print(chunk.content, end='', flush=True)
48-
49-
# Initialize with streaming callback
50-
chat_generator = GoogleGenAIChatGenerator(
51-
model="gemini-2.0-flash",
52-
streaming_callback=streaming_callback
53-
)
54-
55-
# Generate a streaming response
56-
messages = [ChatMessage.from_user("Write a short story")]
57-
response = chat_generator.run(messages=messages)
58-
# Text will stream in real-time via the callback
59-
```
60-
61-
## License
62-
63-
`google-genai-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
15+
To run integration tests locally, you need to export the `GOOGLE_API_KEY` environment variable.

‎integrations/google_vertex/README.md‎

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,11 @@
33
[![PyPI - Version](https://img.shields.io/pypi/v/google-vertex-haystack.svg)](https://pypi.org/project/google-vertex-haystack)
44
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/google-vertex-haystack.svg)](https://pypi.org/project/google-vertex-haystack)
55

6-
---
7-
8-
**Table of Contents**
9-
10-
- [google-vertex-haystack](#google-vertex-haystack)
11-
- [Installation](#installation)
12-
- [Contributing](#contributing)
13-
- [License](#license)
14-
15-
## Installation
6+
- [Integration page](https://haystack.deepset.ai/integrations/google-vertex-ai)
7+
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/google_vertex/CHANGELOG.md)
168

17-
```console
18-
pip install google-vertex-haystack
19-
```
9+
---
2010

2111
## Contributing
2212

23-
`hatch` is the best way to interact with this project, to install it:
24-
25-
```sh
26-
pip install hatch
27-
```
28-
29-
With `hatch` installed, to run all the tests:
30-
31-
```
32-
hatch run test:all
33-
```
34-
35-
To format your code and perform linting using Ruff (with automatic fixes), run:
36-
37-
```
38-
hatch run fmt
39-
```
40-
41-
To check for static type errors, run:
42-
43-
```console
44-
$ hatch run test:types
45-
```
46-
47-
## License
48-
49-
`google-vertex-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
13+
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

‎integrations/hanlp/README.md‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,11 @@
33
[![PyPI - Version](https://img.shields.io/pypi/v/hanlp-haystack.svg)](https://pypi.org/project/hanlp-haystack)
44
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hanlp-haystack.svg)](https://pypi.org/project/hanlp-haystack)
55

6-
-----
6+
- [Integration page](https://haystack.deepset.ai/integrations/hanlp)
7+
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/hanlp/CHANGELOG.md)
78

8-
## Table of Contents
9+
---
910

10-
- [Installation](#installation)
11-
- [License](#license)
11+
## Contributing
1212

13-
## Installation
14-
15-
```console
16-
pip install hanlp-haystack
17-
```
18-
19-
## License
20-
21-
`hanlp-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
13+
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)