# LChat
Large Language Model (LLM) chat command line inteferace based using [HuggingFace](https://huggingface.co/).
## Installation
```
pip install lchat
```
## Usage
You will likely need to login via [huggingface_hub](https://huggingface.co/docs/huggingface_hub/quick-start#authentication).
The usage is very simple, to enter the chat prompt run:
```
python -m lchat
```
The arguments that can be passed to lchat are as follows:
```
usage: lchat [-h] [-p PROMPT] [-m MODEL] [-l]
Sends an input to a HuggingFace LLM.
options:
-h, --help show this help message and exit
-p PROMPT, --prompt PROMPT
Type of prompt to use. '' for none, 'email' for email.
-m MODEL, --model MODEL
Hugging Face model to use.
-l, --list List default prompts.
```
- To quit from the chat prompt, type `q` or `quit`.
- To erase all message history type `c` or `clear`.
- To show the help menu, type `h` or `help`.
Chats are not saved between sessions.
The `>>>` prompt is the prompt that awaits your input.
The `['.'] ... ` prompt is the LLM response.
## License
This project is licensed under the GNU GPL v3 license which can be found [here](LICENSE).
## Contributing
Issues and pull requests welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/abdrysdale/lchat",
"name": "lchat",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Alex Drysdale",
"author_email": "alexander.drysdale@wales.nhs.uk",
"download_url": "https://files.pythonhosted.org/packages/60/b4/2c4598c7fce201b015add3657baeacc98c9fcc17838363b5b8fb64f4e15d/lchat-0.2.3.tar.gz",
"platform": null,
"description": "# LChat\n\nLarge Language Model (LLM) chat command line inteferace based using [HuggingFace](https://huggingface.co/).\n\n\n## Installation\n\n```\npip install lchat\n```\n\n## Usage\n\nYou will likely need to login via [huggingface_hub](https://huggingface.co/docs/huggingface_hub/quick-start#authentication).\n\nThe usage is very simple, to enter the chat prompt run:\n\n```\npython -m lchat\n```\n\nThe arguments that can be passed to lchat are as follows:\n\n```\nusage: lchat [-h] [-p PROMPT] [-m MODEL] [-l]\n\nSends an input to a HuggingFace LLM.\n\noptions:\n -h, --help show this help message and exit\n -p PROMPT, --prompt PROMPT\n Type of prompt to use. '' for none, 'email' for email.\n -m MODEL, --model MODEL\n Hugging Face model to use.\n -l, --list List default prompts.\n```\n\n- To quit from the chat prompt, type `q` or `quit`.\n- To erase all message history type `c` or `clear`.\n- To show the help menu, type `h` or `help`.\n\nChats are not saved between sessions.\n\nThe `>>>` prompt is the prompt that awaits your input.\nThe `['.'] ... ` prompt is the LLM response.\n\n## License\n\nThis project is licensed under the GNU GPL v3 license which can be found [here](LICENSE).\n\n## Contributing\n\nIssues and pull requests welcome!\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Hugging Face inference chat CLI client.",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/abdrysdale/lchat",
"Repository": "https://github.com/abdrysdale/lchat"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "244e52cf0c874db3fee4ba58e55c319d8e16a3f09d42e38e23aea4dc2ed6072a",
"md5": "678462e5863357e4819cdc151f978cb9",
"sha256": "351e919b6b9e73dc4fd0b5ff87c18cbcac97a51a50a15e5a2eb78b47870209b9"
},
"downloads": -1,
"filename": "lchat-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "678462e5863357e4819cdc151f978cb9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 18508,
"upload_time": "2024-09-07T09:13:43",
"upload_time_iso_8601": "2024-09-07T09:13:43.024020Z",
"url": "https://files.pythonhosted.org/packages/24/4e/52cf0c874db3fee4ba58e55c319d8e16a3f09d42e38e23aea4dc2ed6072a/lchat-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60b42c4598c7fce201b015add3657baeacc98c9fcc17838363b5b8fb64f4e15d",
"md5": "ef9cd9fcf467d3f94744a7f7285dc7e6",
"sha256": "2810711b17c1fc7baec2ed2cca85f203d7cbe890b75120ce05235932dab59315"
},
"downloads": -1,
"filename": "lchat-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "ef9cd9fcf467d3f94744a7f7285dc7e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 17235,
"upload_time": "2024-09-07T09:13:44",
"upload_time_iso_8601": "2024-09-07T09:13:44.620809Z",
"url": "https://files.pythonhosted.org/packages/60/b4/2c4598c7fce201b015add3657baeacc98c9fcc17838363b5b8fb64f4e15d/lchat-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 09:13:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abdrysdale",
"github_project": "lchat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "lchat"
}
JSON
