| Name | quackamollie-devtools JSON |
| Version |
0.1
JSON |
| download |
| home_page | None |
| Summary | Development tools for the command line interface (CLI) of Quackamollie Telegram chat bot |
| upload_time | 2024-09-21 17:45:45 |
| 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 |
telegram
bot
aiogram
llamaindex
ollama
llmsherpa
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
==========================
Quackamollie CLI Dev Tools
==========================
:Name: Quackamollie CLI Dev Tools
:Package name: quackamollie-devtools
:Description: Development tools for the command line interface (CLI) of Quackamollie Telegram chat bot
:Version: 0.1
:Main page: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools
:PyPI package: https://pypi.org/project/quackamollie-devtools
:Documentation: https://devtools-forge-of-absurd-ducks-quackamollie-lib--0cee136bdd04d9.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/cli/quackamollie_devtools/badges/master/pipeline.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/commits/master
:alt: Master pipeline status
.. |master_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/badges/master/coverage.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/commits/master
:alt: Master coverage status
.. |dev_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/badges/dev/pipeline.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/commits/dev
:alt: Dev pipeline status
.. |dev_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/badges/dev/coverage.svg
:target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/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/>`_.
Quackamollie implements also a command line interface `quackamollie`.
This package is an extension of the command line interface `quackamollie` with common tools for development, for the Quackamollie project.
It contains:
- a click command `generate_db_schema` registered through entrypoint for use with `quackamollie db schema`
Learn more about Quackamollie on the `project main page <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_.
Requirements
============
System requirements
-------------------
Ensure you have `graphviz` installed on your system.
- For instance on Debian systems
.. code-block:: bash
apt update
apt install graphviz
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://devtools-forge-of-absurd-ducks-quackamollie-lib--0cee136bdd04d9.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-devtools-0.1.tar.gz
- Or install it from wheel
.. code-block:: bash
pip install dist/quackamollie-devtools-0.1.whl
- Or install it from PyPi repository
.. code-block:: bash
pip install quackamollie-devtools # latest
# or
pip install "quackamollie-devtools==0.1"
Generating a schema
===================
`quackamollie-devtools` package is automatically discovered, through entrypoints, by the command tool line named `quackamollie`.
Therefore, once installed, you should automatically be able to call `quackamollie db schema -h` to see the help of this command.
You can generate a schema with:
.. code-block:: bash
# Specify only the directory to generate a schema, here at path 'schemas/quackamollie_schema_v{core_version}.png'
quackamollie db schema -od schemas
# Specify a file name to generate a PNG schema with a specific name
quackamollie db schema -of schemas/quackamollie_schema_latest.png
Authors
=======
- **QuacktorAI** - *Initial work* - `quacktorai <https://gitlab.com/quacktorai>`_
Contributing
============
If you want to report a bug or ask for a new feature of `quackamollie-devtools`, please open an issue
in the `Gitlab ticket management section of this project <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/-/issues>`_.
Please, first ensure that your issue is not redundant with already open issues.
If you want to contribute code to this project, please open first an issue and then a merge request with commit names referencing this issues.
Note that only fast-forward merge requests are accepted.
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/cli/quackamollie_devtools/-/blob/master/CONTRIBUTING.md>`_.
Credits
=======
Section in writing, sorry for the inconvenience.
Raw data
{
"_id": null,
"home_page": null,
"name": "quackamollie-devtools",
"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/f6/47/0eb9a8ef6e83081e1d010d55529d429ab688375781bf80a622fc9c770867/quackamollie_devtools-0.1.tar.gz",
"platform": null,
"description": "==========================\nQuackamollie CLI Dev Tools\n==========================\n\n:Name: Quackamollie CLI Dev Tools\n:Package name: quackamollie-devtools\n:Description: Development tools for the command line interface (CLI) of Quackamollie Telegram chat bot\n:Version: 0.1\n:Main page: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools\n:PyPI package: https://pypi.org/project/quackamollie-devtools\n:Documentation: https://devtools-forge-of-absurd-ducks-quackamollie-lib--0cee136bdd04d9.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/cli/quackamollie_devtools/badges/master/pipeline.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/commits/master\n :alt: Master pipeline status\n.. |master_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/badges/master/coverage.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/commits/master\n :alt: Master coverage status\n\n.. |dev_pipeline_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/badges/dev/pipeline.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/commits/dev\n :alt: Dev pipeline status\n.. |dev_coverage_badge| image:: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/badges/dev/coverage.svg\n :target: https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/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/>`_.\nQuackamollie implements also a command line interface `quackamollie`.\n\nThis package is an extension of the command line interface `quackamollie` with common tools for development, for the Quackamollie project.\nIt contains:\n\n - a click command `generate_db_schema` registered through entrypoint for use with `quackamollie db schema`\n\nLearn more about Quackamollie on the `project main page <https://gitlab.com/forge_of_absurd_ducks/quackamollie/quackamollie>`_.\n\n\nRequirements\n============\n\nSystem requirements\n-------------------\nEnsure you have `graphviz` installed on your system.\n\n- For instance on Debian systems\n\n.. code-block:: bash\n\n apt update\n apt install graphviz\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://devtools-forge-of-absurd-ducks-quackamollie-lib--0cee136bdd04d9.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-devtools-0.1.tar.gz\n\n- Or install it from wheel\n\n.. code-block:: bash\n\n pip install dist/quackamollie-devtools-0.1.whl\n\n- Or install it from PyPi repository\n\n.. code-block:: bash\n\n pip install quackamollie-devtools # latest\n # or\n pip install \"quackamollie-devtools==0.1\"\n\n\nGenerating a schema\n===================\n`quackamollie-devtools` package is automatically discovered, through entrypoints, by the command tool line named `quackamollie`.\nTherefore, once installed, you should automatically be able to call `quackamollie db schema -h` to see the help of this command.\n\nYou can generate a schema with:\n\n.. code-block:: bash\n\n # Specify only the directory to generate a schema, here at path 'schemas/quackamollie_schema_v{core_version}.png'\n quackamollie db schema -od schemas\n\n # Specify a file name to generate a PNG schema with a specific name\n quackamollie db schema -of schemas/quackamollie_schema_latest.png\n\n\nAuthors\n=======\n\n- **QuacktorAI** - *Initial work* - `quacktorai <https://gitlab.com/quacktorai>`_\n\n\nContributing\n============\nIf you want to report a bug or ask for a new feature of `quackamollie-devtools`, please open an issue\nin the `Gitlab ticket management section of this project <https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools/-/issues>`_.\nPlease, first ensure that your issue is not redundant with already open issues.\n\nIf you want to contribute code to this project, please open first an issue and then a merge request with commit names referencing this issues.\nNote that only fast-forward merge requests are accepted.\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/cli/quackamollie_devtools/-/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": "Development tools for the command line interface (CLI) of Quackamollie Telegram chat bot",
"version": "0.1",
"project_urls": {
"Homepage": "https://gitlab.com/forge_of_absurd_ducks/quackamollie/lib/cli/quackamollie_devtools"
},
"split_keywords": [
"telegram",
" bot",
" aiogram",
" llamaindex",
" ollama",
" llmsherpa"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "109bea09044defa97f2cafdeb899b980c66b7af44b8de1c641a70842c8b6bfd3",
"md5": "9229cb7a6dae692e9b6c664a4af8826f",
"sha256": "387b07ee52965f29a97fa527c8a0c03a722fc9300b675609a6ec4935b591e669"
},
"downloads": -1,
"filename": "quackamollie_devtools-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9229cb7a6dae692e9b6c664a4af8826f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7742,
"upload_time": "2024-09-21T17:45:43",
"upload_time_iso_8601": "2024-09-21T17:45:43.049876Z",
"url": "https://files.pythonhosted.org/packages/10/9b/ea09044defa97f2cafdeb899b980c66b7af44b8de1c641a70842c8b6bfd3/quackamollie_devtools-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6470eb9a8ef6e83081e1d010d55529d429ab688375781bf80a622fc9c770867",
"md5": "3540f4f2665dc338a0ea57dd20d0a65d",
"sha256": "a57c9c92bf99d0d7ac81e1502da609ecf7600f4580258084e9c2599a8214c7c6"
},
"downloads": -1,
"filename": "quackamollie_devtools-0.1.tar.gz",
"has_sig": false,
"md5_digest": "3540f4f2665dc338a0ea57dd20d0a65d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 18515,
"upload_time": "2024-09-21T17:45:45",
"upload_time_iso_8601": "2024-09-21T17:45:45.077781Z",
"url": "https://files.pythonhosted.org/packages/f6/47/0eb9a8ef6e83081e1d010d55529d429ab688375781bf80a622fc9c770867/quackamollie_devtools-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 17:45:45",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "forge_of_absurd_ducks",
"gitlab_project": "quackamollie",
"lcname": "quackamollie-devtools"
}
