{"id":28478845,"url":"https://github.com/ekonda/kutana","last_synced_at":"2025-07-03T09:31:00.265Z","repository":{"id":41519350,"uuid":"146949054","full_name":"ekonda/kutana","owner":"ekonda","description":"The library for developing systems for messengers and social networks","archived":false,"fork":false,"pushed_at":"2024-11-19T07:51:25.000Z","size":1918,"stargazers_count":75,"open_issues_count":4,"forks_count":18,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-07T18:07:18.582Z","etag":null,"topics":["asyncio","bot","engine","messengers","python","python3","social-networks"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ekonda.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-08-31T22:52:35.000Z","updated_at":"2025-05-23T10:37:49.000Z","dependencies_parsed_at":"2023-12-03T13:25:18.945Z","dependency_job_id":"f6307298-b223-4af0-a8e9-1fb68d393fc4","html_url":"https://github.com/ekonda/kutana","commit_stats":{"total_commits":230,"total_committers":9,"mean_commits":"25.555555555555557","dds":"0.10434782608695647","last_synced_commit":"92fd73b9fc35a217ae544840315234139a36eb54"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/ekonda/kutana","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekonda%2Fkutana","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekonda%2Fkutana/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekonda%2Fkutana/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekonda%2Fkutana/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ekonda","download_url":"https://codeload.github.com/ekonda/kutana/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekonda%2Fkutana/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263300114,"owners_count":23445187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","bot","engine","messengers","python","python3","social-networks"],"created_at":"2025-06-07T18:07:15.386Z","updated_at":"2025-07-03T09:31:00.258Z","avatar_url":"https://github.com/ekonda.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kutana\n\n![Kutana logo](./docs/kutana-logo-512.png?raw=true \"Kutana\")\n\n[![PyPI version](https://badge.fury.io/py/kutana.svg)](https://badge.fury.io/py/kutana)\n\nThe library for developing systems for messengers and social networks. Great\nfor developing bots. Refer to [example](https://github.com/ekonda/kutana/tree/master/example)\nfor the showcase of the library abilities.\n\nThis library uses generalized attachment types, possible actions e.t.c. for flexibility\nto use plugins with different backends.\n\n## Installation\n\n```bash\npython -m pip install kutana\n```\n\n## Documentation\n\nYou can read the extended description of the library in\nthe [docs/index.md](example/config.example.yml) file. At the moment,\nthe documentation is not in the best condition. If you would like\nto contribute to its writing, welcome to the issues.\n\n## Running\n\n### From CLI\n\nFollowing command will populate application's config, add specified backends and\nload plugins from specified folder.\n\n```bash\npython3 -m kutana run example/config.yml\n\n# usage: kutana [-h] {init,run} ...\n#\n# helpfull cli utility\n#\n# positional arguments:\n#   {init,run}\n#     init      initiate kutana project\n#     run       run kutana project using provided config (working directory will be changed to the one with config file)\n#\n# optional arguments:\n#   -h, --help  show this help message and exit\n```\n\nRefer to the example [config.yml](example/config.example.yml)\nfor the configuration details.\n\n### From code\n\n```py\nfrom kutana import Kutana\nfrom kutana.backends import VkontakteLongpoll\nfrom kutana.loaders import load_plugins_from_path\n\n# Create application\napp = Kutana()\n\n# Add manager to application\napp.add_backend(VkontakteLongpoll(token=\"VK-GROUP-TOKEN\"))\n\n# Load and register plugins\nfor plugin in load_plugins_from_path(\"example/plugins/\"):\n    app.add_plugin(plugin)\n\nif __name__ == \"__main__\":\n    # Run application\n    app.run()\n```\n\n## Example plugin (`plugins/echo.py`)\n\n```py\nfrom kutana import Plugin\n\nplugin = Plugin(name=\"Echo\")\n\n@plugin.on_commands([\"echo\"])\nasync def _(msg, ctx):\n    await ctx.reply(ctx.body, attachments=msg.attachments)\n```\n\n\u003e If your function exists only to be decorated, you can use `_` to avoid\n\u003e unnecessary names.\n\n## Available backends\n\n- Vkontakte (for [vk.com](https://vk.com) groups)\n- Telegram (for [telegram.org](https://telegram.org) bots)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fekonda%2Fkutana","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fekonda%2Fkutana","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fekonda%2Fkutana/lists"}