<!-- Filename: README.md -->
<!-- Author: Jonathan Delgado -->
<!-- Description: GitHub README -->
<!-- Header -->
<h2 align="center">Typing Filter</h2>
<p align="center">
Simple CLI for a typing filter to provide choices to a user and let them type in phrases which filters possible options.
<br />
<br />
Status: <em>in progress</em>
<!-- Documentation link -->
<!-- ·<a href="https://stochastic-thermodynamics-in-python.readthedocs.io/en/latest/"><strong>
Documentation
</strong></a> -->
<!-- Notion Roadmap link -->
·<a href="https://otanan.notion.site/Typing-Filter-bf53e901c68b4e11b231d4d4578d32f2"><strong>
Notion Roadmap »
</strong></a>
</p>
</div>
<!-- Project Demo -->
https://user-images.githubusercontent.com/6320907/230550634-3ac6b92a-bbd2-4723-93ce-218ad02d8a31.mov
<!-- ## Table of contents
* [Contact](#contact)
* [Acknowledgments](#acknowledgments) -->
## Installation
Install the package from [PyPi](https://pypi.org/project/typing-filter/) via pip
```sh
pip install typing-filter
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Usage
With a list of options ready, a list of descriptions, just import the package call the launch function.
```python
import typing_filter
options = ['Alaska', 'Massachusetts', 'California']
descriptions = [None, 'My home state', 'My current state']
choice = typing_filter.launch(options, descriptions)
```
The selected choice is returned by the launch function, and is None if the operation was canceled.
Additional options can be made by tweaking the launch command:
```python
import typing_filter
options = ['Alaska', 'Massachusetts', 'California']
descriptions = [None, 'My home state', 'My current state']
choice = typing_filter.launch(
options, descriptions,
description_separator=': ',
header='Press Escape to quit!',
prompt='Input:',
selector='==>>', selector_padding=3
)
```
<!-- _For more examples, please refer to the [Documentation]._ -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Roadmap
Refer to the [Notion Roadmap] for future features and the state of the project.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contact
Created by [Jonathan Delgado](https://jdelgado.net/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
[Notion Roadmap]: https://otanan.notion.site/
[Documentation]: https://stochastic-thermodynamics-in-python.readthedocs.io/en/latest/
Raw data
{
"_id": null,
"home_page": "https://jdelgado.net/",
"name": "typing-filter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "select,choice,filter,CLI,inquirer",
"author": "Jonathan Delgado",
"author_email": "jonathandelgado0327@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5b/19/7e2a0aae393871b669d2ef46d3ff809ebc32ac35bb1cd92ef7a5f57bdc26/typing_filter-0.1.1.tar.gz",
"platform": null,
"description": "<!-- Filename: README.md -->\n<!-- Author: Jonathan Delgado -->\n<!-- Description: GitHub README -->\n\n<!-- Header -->\n<h2 align=\"center\">Typing Filter</h2>\n <p align=\"center\">\n Simple CLI for a typing filter to provide choices to a user and let them type in phrases which filters possible options.\n <br />\n <br />\n Status: <em>in progress</em>\n <!-- Documentation link -->\n <!-- \u00b7<a href=\"https://stochastic-thermodynamics-in-python.readthedocs.io/en/latest/\"><strong>\n Documentation\n </strong></a> -->\n <!-- Notion Roadmap link -->\n \u00b7<a href=\"https://otanan.notion.site/Typing-Filter-bf53e901c68b4e11b231d4d4578d32f2\"><strong>\n Notion Roadmap \u00bb\n </strong></a>\n </p>\n</div>\n\n\n<!-- Project Demo -->\nhttps://user-images.githubusercontent.com/6320907/230550634-3ac6b92a-bbd2-4723-93ce-218ad02d8a31.mov\n\n\n<!-- ## Table of contents\n* [Contact](#contact)\n* [Acknowledgments](#acknowledgments) -->\n\n\n## Installation\nInstall the package from [PyPi](https://pypi.org/project/typing-filter/) via pip\n ```sh\n pip install typing-filter\n ```\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n## Usage\nWith a list of options ready, a list of descriptions, just import the package call the launch function.\n```python\nimport typing_filter\noptions = ['Alaska', 'Massachusetts', 'California']\ndescriptions = [None, 'My home state', 'My current state']\nchoice = typing_filter.launch(options, descriptions)\n```\nThe selected choice is returned by the launch function, and is None if the operation was canceled.\n\nAdditional options can be made by tweaking the launch command:\n```python\nimport typing_filter\noptions = ['Alaska', 'Massachusetts', 'California']\ndescriptions = [None, 'My home state', 'My current state']\nchoice = typing_filter.launch(\n options, descriptions,\n description_separator=': ',\n header='Press Escape to quit!',\n prompt='Input:',\n selector='==>>', selector_padding=3\n)\n```\n\n<!-- _For more examples, please refer to the [Documentation]._ -->\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n## Roadmap\n\nRefer to the [Notion Roadmap] for future features and the state of the project.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n## Contact\nCreated by [Jonathan Delgado](https://jdelgado.net/).\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n[Notion Roadmap]: https://otanan.notion.site/\n[Documentation]: https://stochastic-thermodynamics-in-python.readthedocs.io/en/latest/\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE",
"summary": "Simple CLI to provide choices to a user, and let them type in phrases which filters possible options.",
"version": "0.1.1",
"split_keywords": [
"select",
"choice",
"filter",
"cli",
"inquirer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c83df23171033360d299b0e90d2e238e3a156027fa992e4d038426b9713a9e7",
"md5": "daecd3dcfcc2d466d9870690f32e76c2",
"sha256": "9e320f7352c2fa2b3be3ecebcc5e8d91885382c7cf93e42537ea279200991692"
},
"downloads": -1,
"filename": "typing_filter-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "daecd3dcfcc2d466d9870690f32e76c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 30709,
"upload_time": "2023-04-07T06:02:06",
"upload_time_iso_8601": "2023-04-07T06:02:06.431460Z",
"url": "https://files.pythonhosted.org/packages/0c/83/df23171033360d299b0e90d2e238e3a156027fa992e4d038426b9713a9e7/typing_filter-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b197e2a0aae393871b669d2ef46d3ff809ebc32ac35bb1cd92ef7a5f57bdc26",
"md5": "9da180a5f29fe7a0d718255189692b59",
"sha256": "ef58d19f36d71226849000d9db169f5cf00c6588e924a5998afcd48af36a8c6d"
},
"downloads": -1,
"filename": "typing_filter-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9da180a5f29fe7a0d718255189692b59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17752,
"upload_time": "2023-04-07T06:02:08",
"upload_time_iso_8601": "2023-04-07T06:02:08.267799Z",
"url": "https://files.pythonhosted.org/packages/5b/19/7e2a0aae393871b669d2ef46d3ff809ebc32ac35bb1cd92ef7a5f57bdc26/typing_filter-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 06:02:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "typing-filter"
}
JSON