<div align="center">
# LocalAssistant
**Locas - your local assistant**
[![][latest-release-shield]][latest-release-url]
[![][latest-commit-shield]][latest-commit-url]
[![][pypi-shield]][pypi-url]
[![][python-shield]][python-url]
[latest-release-shield]: https://badgen.net/github/release/Linos1391/LocalAssistant/development?icon=github
[latest-release-url]: https://github.com/Linos1391/LocalAssistant/releases/latest
[latest-commit-shield]: https://badgen.net/github/last-commit/Linos1391/LocalAssistant/main?icon=github
[latest-commit-url]: https://github.com/Linos1391/LocalAssistant/commits/main
[pypi-shield]: https://img.shields.io/badge/pypi-LocalAssistant-blue
[pypi-url]: https://pypi.org/project/LocalAssistant/
[python-shield]: https://img.shields.io/badge/python-3.10+-yellow
[python-url]: https://www.python.org/downloads/
**Your CLI friend.**
</div>
<br>
```
>> locas -h
usage: locas [-h] [-v] [-V] COMMAND ...
LocalAssistant (locas) is an AI designed to be used in CLI.
options:
-h, --help show this help message and exit
-v, --verbose show debug messages (Can be used multiple times for higher level: CRITICAL[v] -> DEBUG[vvvv])
-V, --version show program's version number and exit
commands:
built-in commands (type 'locas COMMAND -h' for better description).
COMMAND
download Download models from Hugging Face
config Configurate LocalAssistant.
user Config user.
chat Chat with models for limited lines. (no history saved)
start Chat with models using history.
docs Ask information from provided documents.
self-destruction LocalAssistant's self-destruction.
```
<br>
# Brief Overview
LocalAssistant is an AI that communicating through terminal. Even though currently in development, it is equipped with communication function, memory ability and document query. I made this for an even bigger project later, so until fully completed, it will not be dropped.
<br>
# Documents
To learn more, read docs at [here](https://localassistant.readthedocs.io/en/latest/).
<br>
# Contribution
Below is what I tried but could not get it done. So your help will help me a lot!
- **Call time:** I tested `locas` with Powershell's `Measure-Command`, I got 7-9s. But then when trying with `CProfile.run()`, it's approximately 0.2s... Why...?
- **pytest:** I know this sounds wrong, but I don't even know where to start. Maybe I will try again, but not right now I guess.
Not just those above. All contributions are welcomed, I would be grateful for one day having peer coders beside me!
<br>
# License
[GNU GPLv3](LICENSE)
<br>
# Disclaimer
This AI was designed to communicating with Hugging Face models in CLI. Please do not use this AI for any unethical reasons. Any damages from abusing this application will not be the responsibility of the author.
Raw data
{
"_id": null,
"home_page": null,
"name": "LocalAssistant",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Linos",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b5/e1/c14bf873696de9abae6bab1ae8df09e973a48244d53297de83d0a611926b/localassistant-1.1.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# LocalAssistant\n\n**Locas - your local assistant**\n\n[![][latest-release-shield]][latest-release-url]\n[![][latest-commit-shield]][latest-commit-url]\n[![][pypi-shield]][pypi-url]\n[![][python-shield]][python-url]\n\n[latest-release-shield]: https://badgen.net/github/release/Linos1391/LocalAssistant/development?icon=github\n[latest-release-url]: https://github.com/Linos1391/LocalAssistant/releases/latest\n[latest-commit-shield]: https://badgen.net/github/last-commit/Linos1391/LocalAssistant/main?icon=github\n[latest-commit-url]: https://github.com/Linos1391/LocalAssistant/commits/main\n[pypi-shield]: https://img.shields.io/badge/pypi-LocalAssistant-blue\n[pypi-url]: https://pypi.org/project/LocalAssistant/\n[python-shield]: https://img.shields.io/badge/python-3.10+-yellow\n[python-url]: https://www.python.org/downloads/\n\n\n\n**Your CLI friend.**\n\n</div>\n\n<br>\n\n```\n>> locas -h\n\nusage: locas [-h] [-v] [-V] COMMAND ...\n\nLocalAssistant (locas) is an AI designed to be used in CLI.\n\noptions:\n -h, --help show this help message and exit\n -v, --verbose show debug messages (Can be used multiple times for higher level: CRITICAL[v] -> DEBUG[vvvv])\n -V, --version show program's version number and exit\n\ncommands:\n built-in commands (type 'locas COMMAND -h' for better description).\n\n COMMAND\n download Download models from Hugging Face\n config Configurate LocalAssistant.\n user Config user.\n chat Chat with models for limited lines. (no history saved)\n start Chat with models using history.\n docs Ask information from provided documents.\n self-destruction LocalAssistant's self-destruction.\n```\n\n<br>\n\n# Brief Overview\n\nLocalAssistant is an AI that communicating through terminal. Even though currently in development, it is equipped with communication function, memory ability and document query. I made this for an even bigger project later, so until fully completed, it will not be dropped.\n\n<br>\n\n# Documents\n\nTo learn more, read docs at [here](https://localassistant.readthedocs.io/en/latest/).\n\n<br>\n\n# Contribution\n\nBelow is what I tried but could not get it done. So your help will help me a lot!\n\n- **Call time:** I tested `locas` with Powershell's `Measure-Command`, I got 7-9s. But then when trying with `CProfile.run()`, it's approximately 0.2s... Why...?\n- **pytest:** I know this sounds wrong, but I don't even know where to start. Maybe I will try again, but not right now I guess.\n\nNot just those above. All contributions are welcomed, I would be grateful for one day having peer coders beside me!\n\n<br>\n\n# License\n\n[GNU GPLv3](LICENSE)\n\n<br>\n\n# Disclaimer\n\nThis AI was designed to communicating with Hugging Face models in CLI. Please do not use this AI for any unethical reasons. Any damages from abusing this application will not be the responsibility of the author.\n",
"bugtrack_url": null,
"license": null,
"summary": "LocalAssistant (locas) is an AI designed to be used in CLI. (Currently in development)",
"version": "1.1.2",
"project_urls": {
"Source": "https://github.com/Linos1391/LocalAssistant"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ad56b8835378bbadaa20d0c94187ce2f23de4612db9e6c7138d47d027aa5a727",
"md5": "81643d0ff76d10409de01f3ee9a62d79",
"sha256": "3e65012ef5727c90402df66cebb6749881ffff37b0d5dd2357eb8808ef5c5588"
},
"downloads": -1,
"filename": "LocalAssistant-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81643d0ff76d10409de01f3ee9a62d79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 37865,
"upload_time": "2025-02-02T18:08:37",
"upload_time_iso_8601": "2025-02-02T18:08:37.206728Z",
"url": "https://files.pythonhosted.org/packages/ad/56/b8835378bbadaa20d0c94187ce2f23de4612db9e6c7138d47d027aa5a727/LocalAssistant-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b5e1c14bf873696de9abae6bab1ae8df09e973a48244d53297de83d0a611926b",
"md5": "f1acb8f8e061d94955e421c547bd6ea4",
"sha256": "1afef1a8b929cb6d1f0afdd4ab4636a4f990b0f6e86e29981a2f7014da402679"
},
"downloads": -1,
"filename": "localassistant-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "f1acb8f8e061d94955e421c547bd6ea4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 33577,
"upload_time": "2025-02-02T18:08:39",
"upload_time_iso_8601": "2025-02-02T18:08:39.152074Z",
"url": "https://files.pythonhosted.org/packages/b5/e1/c14bf873696de9abae6bab1ae8df09e973a48244d53297de83d0a611926b/localassistant-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-02 18:08:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Linos1391",
"github_project": "LocalAssistant",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "transformers",
"specs": []
},
{
"name": "bitsandbytes",
"specs": []
},
{
"name": "sentence-transformers",
"specs": []
},
{
"name": "PyMuPDF",
"specs": []
},
{
"name": "sentencepiece",
"specs": []
},
{
"name": "pyvis",
"specs": []
}
],
"lcname": "localassistant"
}
JSON
