Simple, type-safe access to the ChatNoir search API.
Project description
🔍 chatnoir-api
Simple, type-safe access to the ChatNoir search API.
Installation
pip install chatnoir-api
Usage
from chatnoir.api.v1 import search
api_key: str = "<API_KEY>"
results = search(api_key, "python library")
top_result = next(iter(results))
print(top_result)
Citation
If you use this package, please cite the paper from the ChatNoir authors. You can use the following BibTeX information for citation:
@InProceedings{bevendorff:2018,
address = {Berlin Heidelberg New York},
author = {Janek Bevendorff and Benno Stein and Matthias Hagen and Martin Potthast},
booktitle = {Advances in Information Retrieval. 40th European Conference on IR Research (ECIR 2018)},
editor = {Leif Azzopardi and Allan Hanbury and Gabriella Pasi and Benjamin Piwowarski},
ids = {potthast:2018c,stein:2018c},
month = mar,
publisher = {Springer},
series = {Lecture Notes in Computer Science},
site = {Grenoble, France},
title = {{Elastic ChatNoir: Search Engine for the ClueWeb and the Common Crawl}},
year = 2018
}
Development
To build and develop this package you need to install the build
package:
pip install build
Installation
Install package dependencies:
pip install -e .
Testing
Install test dependencies:
pip install -e .[test]
Verify your changes against the test suite to verify.
flake8 chatnoir examples
pylint -E chatnoir examples
pytest chatnoir examples
Please also add tests for the axioms or integrations you've added.
Build wheel
A wheel for this package can be built by:
python -m build
License
This repository is released under the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
chatnoir-api-0.1.0.tar.gz
(10.3 kB
view hashes)
Built Distribution
Close
Hashes for chatnoir_api-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3101c733fba64f5b855175f2329601a53fcc395a220d959b7920db3d81e0f127 |
|
MD5 | 8dc9ff260d7af51d9d5a7d34bae75538 |
|
BLAKE2b-256 | 1f37be72d934dc8460b1e17315c60065c61570c35b45e721eec7ec443d776318 |