# Keyword Search
A keyword search package for CSV/Excel/Pandas using boolean expressions.
- It works by processing a query string with field indicator for Pandas Dataframe
columns.
- Currently, only `.str.contains` queries are performed.
- Boolean operations (`and`, `or`, `and not`) are mantained during compilation, following Pandas sintax.
- All further work is done by the Pandas `DataFrame.query` method.
Searched field should not contain spaces or `:`.
*Examples:*
`((title:leptospira) and (abstract:vaccine))`
## Installation
```
$ pip install keyword-search
```
## Using as a Python package
```python
from keyword_search.query import keyword_search
df_results = keyword_search(df, "(title:Leptospirosis)")
print(df_results)
```
## Using as a CLI application
```
$ keyword-query papers.csv "(title:leptospira) or (abstract:leptospira)" --delimiter ";" --output results.csv
```
Raw data
{
"_id": null,
"home_page": "",
"name": "keyword-search",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bioinformatics machine-learning data science drug discovery QSAR",
"author": "Frederico Schmitt Kremer",
"author_email": "fred.s.kremer@gmail.com",
"download_url": "",
"platform": null,
"description": "# Keyword Search\n\nA keyword search package for CSV/Excel/Pandas using boolean expressions.\n\n- It works by processing a query string with field indicator for Pandas Dataframe\ncolumns. \n\n- Currently, only `.str.contains` queries are performed. \n\n- Boolean operations (`and`, `or`, `and not`) are mantained during compilation, following Pandas sintax. \n\n- All further work is done by the Pandas `DataFrame.query` method.\n\n\nSearched field should not contain spaces or `:`.\n\n*Examples:*\n\n`((title:leptospira) and (abstract:vaccine))`\n\n## Installation\n\n```\n$ pip install keyword-search\n```\n\n## Using as a Python package\n\n```python\nfrom keyword_search.query import keyword_search\n\ndf_results = keyword_search(df, \"(title:Leptospirosis)\")\nprint(df_results)\n```\n\n## Using as a CLI application\n\n```\n$ keyword-query papers.csv \"(title:leptospira) or (abstract:leptospira)\" --delimiter \";\" --output results.csv\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A keyword search for CSV/Excel/Pandas",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [
"bioinformatics",
"machine-learning",
"data",
"science",
"drug",
"discovery",
"qsar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4eaa21ac222b14ec7621395447d83066b929152d60aacf02f8088317b080ac7",
"md5": "81ee973c595aa0080c337bcae34da229",
"sha256": "1b52754844c24f949d0519538339b228d245751930e154cacf5eb8e37eeea2fc"
},
"downloads": -1,
"filename": "keyword_search-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81ee973c595aa0080c337bcae34da229",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3636,
"upload_time": "2024-02-08T21:06:49",
"upload_time_iso_8601": "2024-02-08T21:06:49.384076Z",
"url": "https://files.pythonhosted.org/packages/e4/ea/a21ac222b14ec7621395447d83066b929152d60aacf02f8088317b080ac7/keyword_search-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 21:06:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "keyword-search"
}