Improved docs (#4)

Author: EdAbati

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Publish to PyPI and TestPyPI
+name: 📢 Publish to PyPI and TestPyPI
 
 on:
     push:
@@ -7,7 +7,7 @@ on:
 
 jobs:
   build:
-    name: Build distribution
+    name: 📦 Build distribution
     runs-on: ubuntu-latest
 
     steps:
@@ -31,7 +31,7 @@ jobs:
 
 
   publish-to-pypi:
-    name: Publish to PyPI
+    name: 🚀 Publish to PyPI
     needs:
     - build
     runs-on: ubuntu-latest
@@ -52,7 +52,7 @@ jobs:
 
 
   github-release:
-    name: Sign the distribution with Sigstore and upload to GitHub Release
+    name: 📝 Sign the distribution with Sigstore and upload to GitHub Release
     needs:
     - publish-to-pypi
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run tests
+name: 🧐 Run tests
 
 on:
   push:

.pre-commit-config.yaml

@@ -21,11 +21,16 @@ repos:
         args: [--py38-plus]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.4
+    rev: v0.3.5
     hooks:
       - id: ruff
 
   - repo: https://github.com/psf/black
     rev: 24.3.0
     hooks:
       - id: black
+
+  - repo: https://github.com/nbQA-dev/nbQA
+    rev: 1.8.5
+    hooks:
+      - id: nbqa-black

LICENSE.txt LICENSELICENSE.txt renamed to LICENSE

@@ -1,30 +1,27 @@
 # Dataframes Haystack
 
 [![PyPI - Version](https://img.shields.io/pypi/v/dataframes-haystack.svg)](https://pypi.org/project/dataframes-haystack)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dataframes-haystack.svg)](https://pypi.org/project/dataframes-haystack)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/EdAbati/dataframes-haystack/main.svg)](https://results.pre-commit.ci/latest/github/EdAbati/dataframes-haystack/main)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dataframes-haystack?logo=python&logoColor=white)](https://pypi.org/project/dataframes-haystack)
+[![PyPI - License](https://img.shields.io/pypi/l/dataframes-haystack.svg)](https://pypi.org/project/dataframes-haystack)
 
------
 
-**Table of Contents**
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/EdAbati/dataframes-haystack/main.svg)](https://results.pre-commit.ci/latest/github/EdAbati/dataframes-haystack/main)
 
-- [Description](#description)
-- [Installation](#installation)
-- [Usage](#usage)
-- [Contributing](#contributing)
-- [License](#license)
+-----
 
-## Description
+## 📃 Description
 
-`dataframes-haystack` is a Python library that allows various dataframe libraries to integrate with [Haystack 2.x](https://docs.haystack.deepset.ai/docs/intro).
+`dataframes-haystack` is an extension for [Haystack 2](https://docs.haystack.deepset.ai/docs/intro) that enables integration with dataframe libraries.
 
-The library offers custom [Converters](https://docs.haystack.deepset.ai/docs/converters) components that convert data in dataframes into Haystack [`Document`s](https://docs.haystack.deepset.ai/docs/data-classes#document).
+The library offers custom [Converters](https://docs.haystack.deepset.ai/docs/converters) components that convert data stored in dataframes into Haystack [`Document`](https://docs.haystack.deepset.ai/docs/data-classes#document) objects.
 
 The dataframe libraries currently supported are:
-- [Pandas](https://pandas.pydata.org/)
+- [pandas](https://pandas.pydata.org/)
 - [Polars](https://pola.rs)
 
-## Installation
+## 🛠️ Installation
 
 ```sh
 # for pandas (pandas is already included in `haystack-ai`)
@@ -34,7 +31,10 @@ pip install dataframes-haystack
 pip install "dataframes-haystack[polars]"
 ```
 
-## Usage
+## 💻 Usage
+
+> [!TIP]
+> See the [Example Notebooks](./notebooks) for complete examples.
 
 ### Pandas
 
@@ -55,7 +55,10 @@ documents = converter.run(df)
 Result:
 ```python
 >>> documents
-{'documents': [Document(id=2eaefcdeb8d31f9f3d543c614233476ff70c0ed5aae609667172786d09588223, content: 'Hello world', meta: {'filename': 'doc1.txt'}), Document(id=bdc99cbfe819356159950dbaffa0521b47ec3ac2ff040604c93fe7798cc71efc, content: 'Hello everyone', meta: {'filename': 'doc2.txt'})]}
+{'documents': [
+    Document(id=0, content: 'Hello world', meta: {'filename': 'doc1.txt'}),
+    Document(id=1, content: 'Hello everyone', meta: {'filename': 'doc2.txt'})
+]}
 ```
 
 ### Polars
@@ -77,10 +80,13 @@ documents = converter.run(df)
 Result:
 ```python
 >>> documents
-{'documents': [Document(id=2eaefcdeb8d31f9f3d543c614233476ff70c0ed5aae609667172786d09588223, content: 'Hello world', meta: {'filename': 'doc1.txt'}), Document(id=bdc99cbfe819356159950dbaffa0521b47ec3ac2ff040604c93fe7798cc71efc, content: 'Hello everyone', meta: {'filename': 'doc2.txt'})]}
+{'documents': [
+    Document(id=0, content: 'Hello world', meta: {'filename': 'doc1.txt'}),
+    Document(id=1, content: 'Hello everyone', meta: {'filename': 'doc2.txt'})
+]}
 ```
 
-## Contributing
+## 🤝 Contributing
 
 Do you have an idea for a new feature? Did you find a bug that needs fixing?
 
@@ -99,6 +105,6 @@ Requirements: [`hatch`](https://hatch.pypa.io/latest/install/), [`pre-commit`](h
 - Linting and formatting checks: `hatch run lint:fmt`
 - Unit tests: `hatch run test-cov-all`
 
-## License
+## ✍️ License
 
 `dataframes-haystack` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.