Adding support for Parquet export format.

Author: harry-rhesis

README.md

@@ -27,6 +27,8 @@ pip install rhesis-sdk
 
 Your API key will be in the format `rh-XXXXXXXXXXXXXXXXXXXX`. Keep this key secure and never share it publicly.
 
+> **Note:** On the Rhesis App, you can also create test sets for your own use cases and access them via the SDK. You only need to connect your GitHub account to create a test set.
+
 ### 2. Configure the SDK
 
 You can configure the Rhesis SDK either through environment variables or direct configuration:
@@ -58,24 +60,7 @@ The Rhesis SDK currently provides functionality to work with Rhesis test sets th
 
 ## Quick Start
 
-You can configure the Rhesis SDK either through environment variables or direct configuration:
-
-### Using Environment Variables
-
-```bash
-export RHESIS_API_KEY="your-api-key"
-export RHESIS_BASE_URL="https://api.rhesis.ai"  # optional
-```
-
-### Direct Configuration
-
-```python
-import rhesis 
-
-# Set configuration directly
-rhesis.base_url = "https://api.rhesis.ai"  # optional
-rhesis.api_key = "rh-XXXXXXXXXXXXXXXXXXXX"
-```
+Before you start, you can configure the Rhesis SDK either through environment variables or direct configuration, as described above.
 
 ### Working with Test Sets
 
@@ -97,6 +82,12 @@ test_set.download()
 
 For more detailed examples, check out our [example notebooks](examples/).
 
+### Generating custom Test Sets
+
+If none of the existing test sets fit your needs, you can generate your own.
+
+You can check out [app.rhesis.ai](http://app.rhesis.ai). There you can define requirements, scenarios and personas, and even import your existing GitHub repository.
+
 ## About Rhesis AI
 
 Rhesis AI helps organizations build Gen AI applications that deliver value, not surprises. Our platform enables you to:
@@ -110,13 +101,21 @@ Made in Potsdam, Germany 🇩🇪
 
 Visit [rhesis.ai](https://rhesis.ai) to learn more about our platform and services.
 
-## Support
+## Community 💬
+
+Join our [Discord server](https://discord.rhesis.ai) to connect with other users and developers.
+
+## Hugging Face 🤗
+
+You can also find us on [Hugging Face](https://huggingface.co/rhesis). There, you can find our test sets across multiple use cases.
+
+## Support 🆘
 
 For questions, issues, or feature requests:
 - Visit our [documentation](https://docs.rhesis.ai)
 - Contact us at support@rhesis.ai
 - Create an issue in this repository
 
-## License
+## License 📝
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

poetry.lock

@@ -34,6 +34,8 @@ pytest = "^8.3.4"
 sphinx = "^8.1.3"
 sphinx-autodoc-typehints = "^3.0.1"
 sphinx-rtd-theme = "^3.0.2"
+typing-extensions = "^4.12.2"
+pyarrow-stubs = {version = ">=17.16", markers = "python_version >= \"3.10\" and python_version < \"4.0\""}
 
 [tool.black]
 line-length = 88
@@ -57,6 +59,7 @@ ipykernel = "^6.29.5"
 pandas = "^2.2.3"
 python-dotenv = "^1.0.1"
 requests = "^2.31.0"
+pyarrow = ">=17.0.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pyproject.toml

@@ -1,48 +1,68 @@
-appnope==0.1.4 ; python_version <= "3.11" and platform_system == "Darwin" and python_version >= "3.9" or python_version >= "3.12" and platform_system == "Darwin"
-asttokens==3.0.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-certifi==2024.12.14 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-cffi==1.17.1 ; python_version <= "3.11" and implementation_name == "pypy" and python_version >= "3.9" or python_version >= "3.12" and implementation_name == "pypy"
-charset-normalizer==3.4.1 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-colorama==0.4.6 ; python_version <= "3.11" and sys_platform == "win32" and python_version >= "3.9" or python_version >= "3.12" and sys_platform == "win32"
-comm==0.2.2 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-debugpy==1.8.12 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-decorator==5.1.1 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-exceptiongroup==1.2.2 ; python_version >= "3.9" and python_version < "3.11"
-executing==2.1.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-idna==3.10 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-importlib-metadata==8.5.0 ; python_version >= "3.9" and python_version < "3.10"
-iniconfig==2.0.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-ipykernel==6.29.5 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-ipython==8.18.1 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-jedi==0.19.2 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-jupyter-client==8.6.3 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-jupyter-core==5.7.2 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-matplotlib-inline==0.1.7 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-nest-asyncio==1.6.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-packaging==24.2 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-parso==0.8.4 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-pexpect==4.9.0 ; python_version <= "3.11" and sys_platform != "win32" and python_version >= "3.9" or python_version >= "3.12" and sys_platform != "win32"
-platformdirs==4.3.6 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-pluggy==1.5.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-prompt-toolkit==3.0.48 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-psutil==6.1.1 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-ptyprocess==0.7.0 ; python_version <= "3.11" and sys_platform != "win32" and python_version >= "3.9" or python_version >= "3.12" and sys_platform != "win32"
-pure-eval==0.2.3 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-pycparser==2.22 ; python_version <= "3.11" and implementation_name == "pypy" and python_version >= "3.9" or python_version >= "3.12" and implementation_name == "pypy"
-pygments==2.19.1 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-pytest==8.3.4 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-python-dateutil==2.9.0.post0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-python-dotenv==1.0.1 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-pywin32==308 ; python_version <= "3.11" and sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.9" or python_version >= "3.12" and sys_platform == "win32" and platform_python_implementation != "PyPy"
-pyzmq==26.2.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-requests==2.32.3 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-six==1.17.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-stack-data==0.6.3 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-tomli==2.2.1 ; python_version >= "3.9" and python_version < "3.11"
-tornado==6.4.2 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-traitlets==5.14.3 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-types-requests==2.32.0.20241016 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "3.10"
-urllib3==2.3.0 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-wcwidth==0.2.13 ; python_version <= "3.11" and python_version >= "3.9" or python_version >= "3.12"
-zipp==3.21.0 ; python_version >= "3.9" and python_version < "3.10"
+alabaster==1.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+appnope==0.1.4 ; python_version <= "3.11" and platform_system == "Darwin" and python_version >= "3.10" or python_version >= "3.12" and platform_system == "Darwin"
+asttokens==3.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+babel==2.16.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+certifi==2024.12.14 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+cffi==1.17.1 ; python_version <= "3.11" and implementation_name == "pypy" and python_version >= "3.10" or python_version >= "3.12" and implementation_name == "pypy"
+charset-normalizer==3.4.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+colorama==0.4.6 ; python_version <= "3.11" and sys_platform == "win32" and python_version >= "3.10" or python_version >= "3.12" and sys_platform == "win32"
+comm==0.2.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+debugpy==1.8.12 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+decorator==5.1.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+docutils==0.21.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+exceptiongroup==1.2.2 ; python_version >= "3.10" and python_version < "3.11"
+executing==2.1.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+idna==3.10 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+imagesize==1.4.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+iniconfig==2.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+ipykernel==6.29.5 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+ipython==8.18.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+jedi==0.19.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+jinja2==3.1.5 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+jupyter-client==8.6.3 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+jupyter-core==5.7.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+markupsafe==3.0.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+matplotlib-inline==0.1.7 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+nest-asyncio==1.6.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+numpy==1.26.4 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+packaging==24.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pandas-stubs==2.2.2.240807 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+parso==0.8.4 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pexpect==4.9.0 ; python_version <= "3.11" and sys_platform != "win32" and python_version >= "3.10" or python_version >= "3.12" and sys_platform != "win32"
+platformdirs==4.3.6 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pluggy==1.5.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+prompt-toolkit==3.0.48 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+psutil==6.1.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+ptyprocess==0.7.0 ; python_version <= "3.11" and sys_platform != "win32" and python_version >= "3.10" or python_version >= "3.12" and sys_platform != "win32"
+pure-eval==0.2.3 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pyarrow-stubs==17.16 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12" and python_version < "4.0"
+pyarrow==19.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pycparser==2.22 ; python_version <= "3.11" and implementation_name == "pypy" and python_version >= "3.10" or python_version >= "3.12" and implementation_name == "pypy"
+pygments==2.19.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pytest==8.3.4 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+python-dateutil==2.9.0.post0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+python-dotenv==1.0.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+pywin32==308 ; python_version <= "3.11" and sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.10" or python_version >= "3.12" and sys_platform == "win32" and platform_python_implementation != "PyPy"
+pyzmq==26.2.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+requests==2.32.3 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+six==1.17.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+snowballstemmer==2.2.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinx-autodoc-typehints==3.0.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinx-rtd-theme==3.0.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinx==8.1.3 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-applehelp==2.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-devhelp==2.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-htmlhelp==2.1.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-jquery==4.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-jsmath==1.0.1 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-qthelp==2.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+sphinxcontrib-serializinghtml==2.0.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+stack-data==0.6.3 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+tomli==2.2.1 ; python_version >= "3.10" and python_version < "3.11"
+tornado==6.4.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+traitlets==5.14.3 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+types-pytz==2024.2.0.20241221 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+types-requests==2.32.0.20241016 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+typing-extensions==4.12.2 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+urllib3==2.3.0 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"
+wcwidth==0.2.13 ; python_version <= "3.11" and python_version >= "3.10" or python_version >= "3.12"