quackamollie-core


Namequackamollie-core JSON
Version 0.1 PyPI version JSON
download
home_pageNone
SummaryCore component of the Quackamollie Telegram chat bot
upload_time2024-09-21 15:46:53
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT 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 telegram bot aiogram llamaindex ollama llmsherpa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =================
Quackamollie-Core
=================

:Name: Quackamollie Core
:Package name: quackamollie-core
:Description: Core of the Quackamollie Telegram personal chat bot
:Version: 0.1
:Main page: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core
:PyPI package: https://pypi.org/project/quackamollie-core/
:Docker Image: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1
:Documentation: https://quackamollie-core-forge-of-absurd-ducks-quackamo-49d876569a9ad7.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/quackamollie_core/badges/master/pipeline.svg
   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/master
   :alt: Master pipeline status
.. |master_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/badges/master/coverage.svg
   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/master
   :alt: Master coverage status

.. |dev_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/badges/dev/pipeline.svg
   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/dev
   :alt: Dev pipeline status
.. |dev_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/badges/dev/coverage.svg
   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/dev
   :alt: Dev coverage status

----

Project description
===================
`Quackamollie <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_ is a `Telegram <https://telegram.org/>`_ chat bot
developed in `Python <https://www.python.org/>`_ using the library `aiogram <https://docs.aiogram.dev/en/latest/>`_ to serve LLM models
running locally using `Ollama <https://ollama.com/>`_.

This package is the **core** of the `Quackamollie <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_ project.
It contains:

- a command line interface which automatically discover addons declared as entrypoints
- the main commands, filters and callbacks for interacting with Quackamollie through Telegram
- `SQLAlchemy <https://www.sqlalchemy.org/>`_ ORM connectors and models to interact with a `PostgreSQL <https://www.postgresql.org/>`_ database for Quackamollie
- `Alembic <https://alembic.sqlalchemy.org/>`_ configuration to automatically migrate the `PostgreSQL <https://www.postgresql.org/>`_ database
- a `Docker Compose <https://docs.docker.com/compose/>`_ configuration file to run a `PostgreSQL <https://www.postgresql.org/>`_ database
- meta-classes for models and model managers
- auto-discovery of models, model managers and CLI subcommands using entrypoints

To install Quackamollie easily with model managers and models, we kindly invite you to refer to the `Quackamollie main project page <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_
which includes tutorials to deploy Quackamollie using `Docker Compose <https://docs.docker.com/compose/>`_.

This documentation mainly contains details destined to developers of the Quackamollie project.
These information can also be useful for developers who want to run Quackamollie locally without using Docker.


About Quackamollie
------------------
This project aims to provide a `Telegram <https://telegram.org/>`_ chat bot for personal use and running on local desktop.

What this project is:

- a Telegram chat bot that you have to run on your own
- a project aiming for personal use and/or use with friends or family
- a project developed by currently one author and offered as an open source project by a non-profit association named the Forge of Absurd Ducks

What this project is NOT:

- it is NOT a platform with servers aiming to provide service to a large number of users
- it is NOT a commercial project


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 `here <https://quackamollie-core-forge-of-absurd-ducks-quackamo-49d876569a9ad7.gitlab.io>`_

  - N.B.: This automatically generated documentation of the Quackamollie core project is still laking a lot of things. Sorry for the inconvenience.


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-core-0.1.tar.gz

- Or install it from wheel

.. code-block:: bash

   pip install dist/quackamollie-core-0.1.whl

- Or install it from PyPi repository

.. code-block:: bash

   pip install quackamollie-core  # latest
   # or
   pip install "quackamollie-core==0.1"


Docker
======
- To build the application docker

.. code-block:: bash

   docker build --network=host -t quackamollie_core:0.1 .

- The official Docker image of this project is available at: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core

- You can pull the image of the current release:

.. code-block:: bash

   docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:latest  # or dev
   # or
   docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1


Docker-compose
==============
- To run database using docker-compose, you must first set environment variables:

  - `QUACKAMOLLIE_DB_HOST`: typically `0.0.0.0`
  - `QUACKAMOLLIE_DB_PORT`: typically `5432`
  - `QUACKAMOLLIE_DB_NAME`: typically `quackamollie`
  - `QUACKAMOLLIE_DB_USERNAME`: typically `quackamollie`
  - `QUACKAMOLLIE_DB_PASSWORD`: choose a strong admin password

- Then you can run:

.. code-block:: bash

   docker compose up
   # or to detach
   docker compose up -d

   # if you need to run it with sudo don't forget to add the -E option to pass the environment variables you've set
   sudo -E docker compose up

Database migration
==================
- Quackamollie provides a wrapper for the `alembic` command which initializes the database info the same way they are
  initialized at runtime. You can call `alembic` by using instead `quackamollie db alembic`. For example:

.. code-block:: bash

   quackamollie db alembic --help

- We recommend you to use a configuration file using one of the examples provided in `config/examples/` and to change
  variables to match the ones used when calling `docker compose up`.

- To create schema revision if the database changes:

.. code-block:: bash

   quackamollie -c config/config.yml db alembic revision --autogenerate -m "A new change."

- You can then inspect the migration code (in python) with:

.. code-block:: bash

   cat migrations/versions/*

- Also inspect the resultant SQL code with:

.. code-block:: bash

   quackamollie -c config/config.yml db alembic upgrade --sql +1

- Finally, you can apply the migration with:

.. code-block:: bash

   quackamollie -c config/config.yml db alembic upgrade +1  # If you want to jump from 1
   quackamollie -c config/config.yml db alembic upgrade head  # If you want to go all the way to head

- If you now connect to ``pgcli``, you can test that the new table exists:

.. code-block:: bash

   make dbtools
   pgcli -U ${QUACKAMOLLIE_DB_USERNAME} -h ${QUACKAMOLLIE_DB_HOST} -p ${QUACKAMOLLIE_DB_PORT} ${QUACKAMOLLIE_DB_NAME}
   # and then on the pgcli console:
   \dt
   # and again on the pgcli console:
   SELECT * FROM users;

- alembic downgrade -1

.. code-block:: bash

   quackamollie -c config/config.yml db alembic downgrade -1

- You can also migrate using the `docker` image from our official docker registry.

.. code-block:: bash

   docker run --rm --name quackamollie-migration \
   --network host \
   --mount type=bind,source="$(pwd)"/config/config.yml,target=/config/config.yml,readonly \
   registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1 \
   -vvvv -c /config/config.yml db alembic upgrade head

   # if you need to run it with sudo don't forget to add the -E option to pass the environment variables you've set
   sudo -E docker run --rm --name quackamollie-migration \
   --network host \
   --mount type=bind,source="$(pwd)"/config/config.yml,target=/config/config.yml,readonly \
   registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1 \
   -vvvv -c /config/config.yml db alembic upgrade head

- To do the same using `docker-compose`, please refer to the `quackamollie` main repository.


Running the project
===================
Quackamollie-core provides a command tool line named `quackamollie`.
You can find examples of configuration files in the folder `config/examples`.

.. code-block:: bash

   quackamollie -vvvv -c config/config.yml serve

Pictures and demonstration videos will be included in the documentation in future releases.


Database
========

- This is the latest schema of the database, generated automatically by the plugin `quackamollie-devtools <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools>`_ (can be installed using `pip install quackamollie-devtools`):

.. image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/-/raw/master/schemas/quackamollie_schema_latest.png
   :alt: Quackamollie database schema automatically generated by plugin quackamollie-devtools


Authors
=======

- **QuacktorAI** - *Initial work* - `quacktorai <https://gitlab.com/quacktorai>`_


Contributing
============
Currently, the project is still in early stages.
It lacks several base features we expect to implement in the versions 0.2 and 0.3, for example RAG capabilities will be added in version 0.2.

For this reason, **we do NOT accept yet issues asking for new features**.
However, you can report bugs or assimilated problems you may encounter and we will do our best to fix them.

If you want to report a bug of `quackamollie-core`, please open an issue in the `Gitlab ticket management section of this project <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/-/issues>`_

For more details on the general contributing mindset of this project, please refer to `CONTRIBUTING.md <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/-/blob/master/CONTRIBUTING.md>`_.


Credits
=======

Section in writing, sorry for the inconvenience.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "quackamollie-core",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "telegram, bot, aiogram, llamaindex, ollama, llmsherpa",
    "author": null,
    "author_email": "QuactorAI <quacktorai@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/56/86/6fbf39ead0b9aede1f1c483f3577aaabb31e740d5b183aa81a7e1fe6493c/quackamollie_core-0.1.tar.gz",
    "platform": null,
    "description": "=================\nQuackamollie-Core\n=================\n\n:Name: Quackamollie Core\n:Package name: quackamollie-core\n:Description: Core of the Quackamollie Telegram personal chat bot\n:Version: 0.1\n:Main page: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core\n:PyPI package: https://pypi.org/project/quackamollie-core/\n:Docker Image: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1\n:Documentation: https://quackamollie-core-forge-of-absurd-ducks-quackamo-49d876569a9ad7.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/quackamollie_core/badges/master/pipeline.svg\n   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/master\n   :alt: Master pipeline status\n.. |master_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/badges/master/coverage.svg\n   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/master\n   :alt: Master coverage status\n\n.. |dev_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/badges/dev/pipeline.svg\n   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/dev\n   :alt: Dev pipeline status\n.. |dev_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/badges/dev/coverage.svg\n   :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/commits/dev\n   :alt: Dev coverage status\n\n----\n\nProject description\n===================\n`Quackamollie <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_ is a `Telegram <https://telegram.org/>`_ chat bot\ndeveloped in `Python <https://www.python.org/>`_ using the library `aiogram <https://docs.aiogram.dev/en/latest/>`_ to serve LLM models\nrunning locally using `Ollama <https://ollama.com/>`_.\n\nThis package is the **core** of the `Quackamollie <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_ project.\nIt contains:\n\n- a command line interface which automatically discover addons declared as entrypoints\n- the main commands, filters and callbacks for interacting with Quackamollie through Telegram\n- `SQLAlchemy <https://www.sqlalchemy.org/>`_ ORM connectors and models to interact with a `PostgreSQL <https://www.postgresql.org/>`_ database for Quackamollie\n- `Alembic <https://alembic.sqlalchemy.org/>`_ configuration to automatically migrate the `PostgreSQL <https://www.postgresql.org/>`_ database\n- a `Docker Compose <https://docs.docker.com/compose/>`_ configuration file to run a `PostgreSQL <https://www.postgresql.org/>`_ database\n- meta-classes for models and model managers\n- auto-discovery of models, model managers and CLI subcommands using entrypoints\n\nTo install Quackamollie easily with model managers and models, we kindly invite you to refer to the `Quackamollie main project page <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_\nwhich includes tutorials to deploy Quackamollie using `Docker Compose <https://docs.docker.com/compose/>`_.\n\nThis documentation mainly contains details destined to developers of the Quackamollie project.\nThese information can also be useful for developers who want to run Quackamollie locally without using Docker.\n\n\nAbout Quackamollie\n------------------\nThis project aims to provide a `Telegram <https://telegram.org/>`_ chat bot for personal use and running on local desktop.\n\nWhat this project is:\n\n- a Telegram chat bot that you have to run on your own\n- a project aiming for personal use and/or use with friends or family\n- a project developed by currently one author and offered as an open source project by a non-profit association named the Forge of Absurd Ducks\n\nWhat this project is NOT:\n\n- it is NOT a platform with servers aiming to provide service to a large number of users\n- it is NOT a commercial project\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 `here <https://quackamollie-core-forge-of-absurd-ducks-quackamo-49d876569a9ad7.gitlab.io>`_\n\n  - N.B.: This automatically generated documentation of the Quackamollie core project is still laking a lot of things. Sorry for the inconvenience.\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-core-0.1.tar.gz\n\n- Or install it from wheel\n\n.. code-block:: bash\n\n   pip install dist/quackamollie-core-0.1.whl\n\n- Or install it from PyPi repository\n\n.. code-block:: bash\n\n   pip install quackamollie-core  # latest\n   # or\n   pip install \"quackamollie-core==0.1\"\n\n\nDocker\n======\n- To build the application docker\n\n.. code-block:: bash\n\n   docker build --network=host -t quackamollie_core:0.1 .\n\n- The official Docker image of this project is available at: registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core\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/quackamollie_core:latest  # or dev\n   # or\n   docker pull registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1\n\n\nDocker-compose\n==============\n- To run database using docker-compose, you must first set environment variables:\n\n  - `QUACKAMOLLIE_DB_HOST`: typically `0.0.0.0`\n  - `QUACKAMOLLIE_DB_PORT`: typically `5432`\n  - `QUACKAMOLLIE_DB_NAME`: typically `quackamollie`\n  - `QUACKAMOLLIE_DB_USERNAME`: typically `quackamollie`\n  - `QUACKAMOLLIE_DB_PASSWORD`: choose a strong admin password\n\n- Then you can run:\n\n.. code-block:: bash\n\n   docker compose up\n   # or to detach\n   docker compose up -d\n\n   # if you need to run it with sudo don't forget to add the -E option to pass the environment variables you've set\n   sudo -E docker compose up\n\nDatabase migration\n==================\n- Quackamollie provides a wrapper for the `alembic` command which initializes the database info the same way they are\n  initialized at runtime. You can call `alembic` by using instead `quackamollie db alembic`. For example:\n\n.. code-block:: bash\n\n   quackamollie db alembic --help\n\n- We recommend you to use a configuration file using one of the examples provided in `config/examples/` and to change\n  variables to match the ones used when calling `docker compose up`.\n\n- To create schema revision if the database changes:\n\n.. code-block:: bash\n\n   quackamollie -c config/config.yml db alembic revision --autogenerate -m \"A new change.\"\n\n- You can then inspect the migration code (in python) with:\n\n.. code-block:: bash\n\n   cat migrations/versions/*\n\n- Also inspect the resultant SQL code with:\n\n.. code-block:: bash\n\n   quackamollie -c config/config.yml db alembic upgrade --sql +1\n\n- Finally, you can apply the migration with:\n\n.. code-block:: bash\n\n   quackamollie -c config/config.yml db alembic upgrade +1  # If you want to jump from 1\n   quackamollie -c config/config.yml db alembic upgrade head  # If you want to go all the way to head\n\n- If you now connect to ``pgcli``, you can test that the new table exists:\n\n.. code-block:: bash\n\n   make dbtools\n   pgcli -U ${QUACKAMOLLIE_DB_USERNAME} -h ${QUACKAMOLLIE_DB_HOST} -p ${QUACKAMOLLIE_DB_PORT} ${QUACKAMOLLIE_DB_NAME}\n   # and then on the pgcli console:\n   \\dt\n   # and again on the pgcli console:\n   SELECT * FROM users;\n\n- alembic downgrade -1\n\n.. code-block:: bash\n\n   quackamollie -c config/config.yml db alembic downgrade -1\n\n- You can also migrate using the `docker` image from our official docker registry.\n\n.. code-block:: bash\n\n   docker run --rm --name quackamollie-migration \\\n   --network host \\\n   --mount type=bind,source=\"$(pwd)\"/config/config.yml,target=/config/config.yml,readonly \\\n   registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1 \\\n   -vvvv -c /config/config.yml db alembic upgrade head\n\n   # if you need to run it with sudo don't forget to add the -E option to pass the environment variables you've set\n   sudo -E docker run --rm --name quackamollie-migration \\\n   --network host \\\n   --mount type=bind,source=\"$(pwd)\"/config/config.yml,target=/config/config.yml,readonly \\\n   registry.gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core:0.1 \\\n   -vvvv -c /config/config.yml db alembic upgrade head\n\n- To do the same using `docker-compose`, please refer to the `quackamollie` main repository.\n\n\nRunning the project\n===================\nQuackamollie-core provides a command tool line named `quackamollie`.\nYou can find examples of configuration files in the folder `config/examples`.\n\n.. code-block:: bash\n\n   quackamollie -vvvv -c config/config.yml serve\n\nPictures and demonstration videos will be included in the documentation in future releases.\n\n\nDatabase\n========\n\n- This is the latest schema of the database, generated automatically by the plugin `quackamollie-devtools <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools>`_ (can be installed using `pip install quackamollie-devtools`):\n\n.. image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/-/raw/master/schemas/quackamollie_schema_latest.png\n   :alt: Quackamollie database schema automatically generated by plugin quackamollie-devtools\n\n\nAuthors\n=======\n\n- **QuacktorAI** - *Initial work* - `quacktorai <https://gitlab.com/quacktorai>`_\n\n\nContributing\n============\nCurrently, the project is still in early stages.\nIt lacks several base features we expect to implement in the versions 0.2 and 0.3, for example RAG capabilities will be added in version 0.2.\n\nFor this reason, **we do NOT accept yet issues asking for new features**.\nHowever, you can report bugs or assimilated problems you may encounter and we will do our best to fix them.\n\nIf you want to report a bug of `quackamollie-core`, please open an issue in the `Gitlab ticket management section of this project <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/-/issues>`_\n\nFor more details on the general contributing mindset of this project, please refer to `CONTRIBUTING.md <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core/-/blob/master/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": "Core component of the Quackamollie Telegram chat bot",
    "version": "0.1",
    "project_urls": {
        "Homepage": "https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/quackamollie_core"
    },
    "split_keywords": [
        "telegram",
        " bot",
        " aiogram",
        " llamaindex",
        " ollama",
        " llmsherpa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6dd370bdbb8388dee3cb55aacead4cfc6a868b63321957dd021fbfbf567db344",
                "md5": "6e7c7acbcb35838cbb683415f8bc2e46",
                "sha256": "d8c7d53575dc57ab157f62f311f9e44d45ec5b04a086e99e3ce902604a2e960e"
            },
            "downloads": -1,
            "filename": "quackamollie_core-0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e7c7acbcb35838cbb683415f8bc2e46",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 71054,
            "upload_time": "2024-09-21T15:46:51",
            "upload_time_iso_8601": "2024-09-21T15:46:51.639390Z",
            "url": "https://files.pythonhosted.org/packages/6d/d3/70bdbb8388dee3cb55aacead4cfc6a868b63321957dd021fbfbf567db344/quackamollie_core-0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "56866fbf39ead0b9aede1f1c483f3577aaabb31e740d5b183aa81a7e1fe6493c",
                "md5": "ebf97a360b9a2c84d8a48864a37de658",
                "sha256": "fc84f842e71aba18a6e389d92ec4efb972d175138a781ffe29e191a705f75132"
            },
            "downloads": -1,
            "filename": "quackamollie_core-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ebf97a360b9a2c84d8a48864a37de658",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 69355,
            "upload_time": "2024-09-21T15:46:53",
            "upload_time_iso_8601": "2024-09-21T15:46:53.978905Z",
            "url": "https://files.pythonhosted.org/packages/56/86/6fbf39ead0b9aede1f1c483f3577aaabb31e740d5b183aa81a7e1fe6493c/quackamollie_core-0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-21 15:46:53",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "forge_of_absurd_ducks",
    "gitlab_project": "quackamollie",
    "lcname": "quackamollie-core"
}
        
Elapsed time: 0.40033s