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")
top10_results = results[:10]
print(top10_results)
result_1234 = results[1234]
print(result_1234)
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_api examples
pylint -E chatnoir_api examples
CHATNOIR_API_KEY="<API_KEY>" pytest chatnoir_api examples
Please also add tests for your newly developed code.
Build wheels
Wheels 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-1.0.0.tar.gz
(13.5 kB
view hashes)
Built Distribution
Close
Hashes for chatnoir_api-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53bb5fc91e6d08e32e385341ee5cafffb94f09728f3179ffa3c7c90ca6eed054 |
|
MD5 | 52f85fbac6f5e0bd5bc299cb8484c166 |
|
BLAKE2b-256 | df17e406ce3786c247f75216b5cfcd7b71a493a798f2c208f9c37b697eed43b5 |