| Name | quackamollie-model-langchain-simple JSON |
| Version |
0.1a0
JSON |
| download |
| home_page | None |
| Summary | Simple Langchain model based on Ollama using Langchain model manager for Quackamollie Telegram chat bot |
| upload_time | 2024-07-13 16:19:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 - Forge of Absurd Ducks Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
quackamollie
model
langchain
ollama
telegram
bot
aiogram
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
===================================
Quackamollie Model Langchain Simple
===================================
:Name: Quackamollie Model Langchain Simple
:Package name: quackamollie-model-langchain-simple
:Description: Simple Langchain model based on Ollama using Langchain model manager for Quackamollie Telegram chat bot
:Version: 0.1a0
:Main page: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple
:PyPI package: https://pypi.org/project/quackamollie-model-langchain-simple/
:Docker Image: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple:0.1a0
:Documentation: https://simple-langchain-model-forge-of-absurd-ducks-qua-dc7b8b58725b30.gitlab.io
:Build Status:
:Master: |master_pipeline_badge| |master_coverage_badge|
:Dev: |dev_pipeline_badge| |dev_coverage_badge|
.. |master_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/master/pipeline.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/master
:alt: Master pipeline status
.. |master_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/master/coverage.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/master
:alt: Master coverage status
.. |dev_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/dev/pipeline.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/dev
:alt: Dev pipeline status
.. |dev_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/dev/coverage.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/dev
:alt: Dev coverage status
----
Project description
===================
Quackamollie is a Telegram chat bot in Python using the library `aiogram` to serve LLM models running locally using Ollama.
This package is a simple Langchain model compatible with the Langchain model manager for the Quackamollie project.
It contains:
- a model `SimpleLangchainQuackamollieModel` class implementing abstract functions of `MetaLangchainQuackamollieModel`
Learn more about Quackamollie on the project main page : https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie
Requirements
============
Virtual environment
------------------------------
- Setup a virtual environment in python 3.10
.. code-block:: bash
make venv
# or
python3 -m venv venv
- Activate the environment
.. code-block:: bash
source venv/bin/activate
- If you want to deactivate the environment
.. code-block:: bash
deactivate
Tests
=====
Tests requirements
------------------
- Install test requirements
.. code-block:: bash
make devtools
# or
pip install tox
Run pytest
----------
- Run the tests
.. code-block:: bash
tox
Run lint
--------
- Run the lintage
.. code-block:: bash
tox -e lint
Documentation
=============
- To auto-generate the documentation configuration
.. code-block:: bash
tox -e gendocs
- To generate the documentation in Html
.. code-block:: bash
tox -e docs
- An automatically generated version of this project documentation can be found at `here <https://simple-langchain-model-forge-of-absurd-ducks-qua-dc7b8b58725b30.gitlab.io>`_
Install
=======
- Install the application from sources
.. code-block:: bash
make install
# or
pip install .
- Or install it from distribution
.. code-block:: bash
pip install dist/quackamollie-model-langchain-simple-0.1a0.tar.gz
- Or install it from wheel
.. code-block:: bash
pip install dist/quackamollie-model-langchain-simple-0.1a0.whl
- Or install it from PyPi repository
.. code-block:: bash
pip install quackamollie-model-langchain-simple # latest
# or
pip install "quackamollie-model-langchain-simple==0.1a0"
Docker
======
- To build the application docker
.. code-block:: bash
docker build --network=host -t quackamollie_model_langchain_simple:0.1a0 .
- The official Docker image of this project is available at: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple
- You can pull the image of the current release:
.. code-block:: bash
docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple:latest # or dev
# or
docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple:0.1a0
Running the model
=================
`quackamollie-model-langchain-simple` package is automatically discovered, through entrypoints, by the Langchain model manager through the command tool line named `quackamollie`.
Therefore, once installed, you should automatically see this model in Telegram `/settings` command.
You should pull an Ollama model for this Langchain model by simply using the `ollama <https://ollama.com/>`_ command tool line:
.. code-block:: bash
ollama pull llama3
For details on how to run the Quackamollie project, please refer to the `Quackamollie's project main page <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_.
Authors
=======
- **QuacktorAI** - *Initial work* - `quacktorai <https://gitlab.com/quacktorai>`_
Contributing
============
Currently, contributions are frozen because the project is still in very early stages and I have yet to push the whole architecture.
For more details on the general contributing mindset of this project, please refer to `CONTRIBUTING.md <CONTRIBUTING.md>`_.
Credits
=======
Section in writing, sorry for the inconvenience.
Raw data
{
"_id": null,
"home_page": null,
"name": "quackamollie-model-langchain-simple",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "quackamollie, model, langchain, ollama, telegram, bot, aiogram",
"author": null,
"author_email": "QuactorAI <quacktorai@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/5f/79d9a3fd435ad8dab0fb490c20cce2432ca8101615448e9d63e7ad894982/quackamollie_model_langchain_simple-0.1a0.tar.gz",
"platform": null,
"description": "===================================\nQuackamollie Model Langchain Simple\n===================================\n\n:Name: Quackamollie Model Langchain Simple\n:Package name: quackamollie-model-langchain-simple\n:Description: Simple Langchain model based on Ollama using Langchain model manager for Quackamollie Telegram chat bot\n:Version: 0.1a0\n:Main page: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple\n:PyPI package: https://pypi.org/project/quackamollie-model-langchain-simple/\n:Docker Image: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple:0.1a0\n:Documentation: https://simple-langchain-model-forge-of-absurd-ducks-qua-dc7b8b58725b30.gitlab.io\n:Build Status:\n :Master: |master_pipeline_badge| |master_coverage_badge|\n :Dev: |dev_pipeline_badge| |dev_coverage_badge|\n\n.. |master_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/master/pipeline.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/master\n :alt: Master pipeline status\n.. |master_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/master/coverage.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/master\n :alt: Master coverage status\n\n.. |dev_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/dev/pipeline.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/dev\n :alt: Dev pipeline status\n.. |dev_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/badges/dev/coverage.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple/commits/dev\n :alt: Dev coverage status\n\n----\n\nProject description\n===================\nQuackamollie is a Telegram chat bot in Python using the library `aiogram` to serve LLM models running locally using Ollama.\nThis package is a simple Langchain model compatible with the Langchain model manager for the Quackamollie project.\nIt contains:\n\n - a model `SimpleLangchainQuackamollieModel` class implementing abstract functions of `MetaLangchainQuackamollieModel`\n\nLearn more about Quackamollie on the project main page : https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie\n\n\nRequirements\n============\n\nVirtual environment\n------------------------------\n- Setup a virtual environment in python 3.10\n\n.. code-block:: bash\n\n make venv\n # or\n python3 -m venv venv\n\n- Activate the environment\n\n.. code-block:: bash\n\n source venv/bin/activate\n\n- If you want to deactivate the environment\n\n.. code-block:: bash\n\n deactivate\n\n\nTests\n=====\n\nTests requirements\n------------------\n- Install test requirements\n\n.. code-block:: bash\n\n make devtools\n # or\n pip install tox\n\nRun pytest\n----------\n- Run the tests\n\n.. code-block:: bash\n\n tox\n\nRun lint\n--------\n- Run the lintage\n\n.. code-block:: bash\n\n tox -e lint\n\n\nDocumentation\n=============\n\n- To auto-generate the documentation configuration\n\n.. code-block:: bash\n\n tox -e gendocs\n\n- To generate the documentation in Html\n\n.. code-block:: bash\n\n tox -e docs\n\n- An automatically generated version of this project documentation can be found at `here <https://simple-langchain-model-forge-of-absurd-ducks-qua-dc7b8b58725b30.gitlab.io>`_\n\n\nInstall\n=======\n- Install the application from sources\n\n.. code-block:: bash\n\n make install\n # or\n pip install .\n\n- Or install it from distribution\n\n.. code-block:: bash\n\n pip install dist/quackamollie-model-langchain-simple-0.1a0.tar.gz\n\n- Or install it from wheel\n\n.. code-block:: bash\n\n pip install dist/quackamollie-model-langchain-simple-0.1a0.whl\n\n- Or install it from PyPi repository\n\n.. code-block:: bash\n\n pip install quackamollie-model-langchain-simple # latest\n # or\n pip install \"quackamollie-model-langchain-simple==0.1a0\"\n\n\nDocker\n======\n- To build the application docker\n\n.. code-block:: bash\n\n docker build --network=host -t quackamollie_model_langchain_simple:0.1a0 .\n\n- The official Docker image of this project is available at: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple\n\n- You can pull the image of the current release:\n\n.. code-block:: bash\n\n docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple:latest # or dev\n # or\n docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple:0.1a0\n\n\nRunning the model\n=================\n`quackamollie-model-langchain-simple` package is automatically discovered, through entrypoints, by the Langchain model manager through the command tool line named `quackamollie`.\nTherefore, once installed, you should automatically see this model in Telegram `/settings` command.\n\nYou should pull an Ollama model for this Langchain model by simply using the `ollama <https://ollama.com/>`_ command tool line:\n\n.. code-block:: bash\n\n ollama pull llama3\n\nFor details on how to run the Quackamollie project, please refer to the `Quackamollie's project main page <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_.\n\n\nAuthors\n=======\n\n- **QuacktorAI** - *Initial work* - `quacktorai <https://gitlab.com/quacktorai>`_\n\n\nContributing\n============\nCurrently, contributions are frozen because the project is still in very early stages and I have yet to push the whole architecture.\n\nFor more details on the general contributing mindset of this project, please refer to `CONTRIBUTING.md <CONTRIBUTING.md>`_.\n\n\nCredits\n=======\n\nSection in writing, sorry for the inconvenience.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 - Forge of Absurd Ducks Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple Langchain model based on Ollama using Langchain model manager for Quackamollie Telegram chat bot",
"version": "0.1a0",
"project_urls": {
"Homepage": "https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/models/langchain/quackamollie_model_langchain_simple"
},
"split_keywords": [
"quackamollie",
" model",
" langchain",
" ollama",
" telegram",
" bot",
" aiogram"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b741df2bee577f21ea25821e5c909bb9bac687b622f1396695894e2c34bf0a42",
"md5": "b23c60f4e0598574ae1b43618ed1a0a2",
"sha256": "4161d1fd5ae2370db7d572f1c11ef9785cb47430a6532f3c1004d5f2fa7dba7c"
},
"downloads": -1,
"filename": "quackamollie_model_langchain_simple-0.1a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b23c60f4e0598574ae1b43618ed1a0a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7866,
"upload_time": "2024-07-13T16:19:10",
"upload_time_iso_8601": "2024-07-13T16:19:10.699850Z",
"url": "https://files.pythonhosted.org/packages/b7/41/df2bee577f21ea25821e5c909bb9bac687b622f1396695894e2c34bf0a42/quackamollie_model_langchain_simple-0.1a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a5f79d9a3fd435ad8dab0fb490c20cce2432ca8101615448e9d63e7ad894982",
"md5": "a4c2a2cbe479036b33e5423a3249c7b9",
"sha256": "b219b622ca6677d82ef0b40e3bc3f7c74381bcee136661e811ee758cf810526b"
},
"downloads": -1,
"filename": "quackamollie_model_langchain_simple-0.1a0.tar.gz",
"has_sig": false,
"md5_digest": "a4c2a2cbe479036b33e5423a3249c7b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 18633,
"upload_time": "2024-07-13T16:19:12",
"upload_time_iso_8601": "2024-07-13T16:19:12.391005Z",
"url": "https://files.pythonhosted.org/packages/4a/5f/79d9a3fd435ad8dab0fb490c20cce2432ca8101615448e9d63e7ad894982/quackamollie_model_langchain_simple-0.1a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 16:19:12",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "forge_of_absurd_ducks",
"gitlab_project": "quackamollie",
"lcname": "quackamollie-model-langchain-simple"
}
