Skip to main content

A Python library to interact with the Qwant search engine AI.

Project description

QwantAI

QwantAI is a Python library that provides an easy-to-use interface for interacting with the Qwant search engine. You can use it to perform searches and retrieve results either as a single text or streamed data in real time via WebSocket.


Features

  • Perform searches on Qwant using a simple Python function.
  • Retrieve results in your preferred language.
  • Choose between streamed real-time output or a single consolidated response.
  • Lightweight and easy to integrate into any project.

Installation

Install QwantAI using pip (once packaged):

pip install QwantAI

If you're developing locally, clone the repository and install it directly:

git clone https://github.com/ramona-flower/QwantAI.git
cd QwantAI
pip install .

Usage Import the package and start searching:

Non-Streamed Example

  • Retrieve all results as a single text response.
import QwantAI

response = QwantAI.search("Python programming", language="en_US", streamed=False)
print(response)

Streamed Example

  • Retrieve results in real-time as they are generated.
import QwantAI

QwantAI.search("Python programming", language="en_US", streamed=True)

Parameters

search(query, language="en_US", streamed=False)

Parameter Type Description Default
query str The search query string. Required
language str The language for the search (e.g., en_US). en_US
streamed bool Whether to stream results or fetch them all at once. False

Requirements

Python 3.6+
requests (for HTTP requests)
websocket-client (for WebSocket communication)

Install dependencies with:

pip install -r requirements.txt

Disclaimer

This project is provided for educational and informational purposes only. The creator of this package is not responsible for any misuse or damages caused by using this tool. Users are responsible for ensuring their usage complies with applicable laws and regulations.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

Fork the repository. Create a feature branch: git checkout -b feature-name

Commit your changes: git commit -m 'Add new feature'

Push to the branch: git push origin feature-name Open a pull request.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more information.

Acknowledgments

Special thanks to the Qwant search engine for providing a robust API.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

QwantAI-1.0.1.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

QwantAI-1.0.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file QwantAI-1.0.1.tar.gz.

File metadata

  • Download URL: QwantAI-1.0.1.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for QwantAI-1.0.1.tar.gz
Algorithm Hash digest
SHA256 64569416163c384b49751f35f06d9bc020f6e126df01d0a14f5dfabe8cef5bca
MD5 41323dd71372c21d82e1b932c7ce98d5
BLAKE2b-256 21ad82908c401be6575847a7ed208c9e3aed57070d5071020f572a0aeaee2c7a

See more details on using hashes here.

File details

Details for the file QwantAI-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: QwantAI-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for QwantAI-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5572f7fe03c07e2d262785c273e6553295c5d9b7ed1512ad6099b227a3b188f7
MD5 b5519b80c9e0c7e4dde4a5e519205058
BLAKE2b-256 dd198e0404647e869b84f49c0b6bf974a13710a249d48d83458c0a95fcfbc115

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page