{"id":43235185,"url":"https://github.com/hwipl/nuqql-based","last_synced_at":"2026-02-01T10:37:40.768Z","repository":{"id":57447373,"uuid":"176910206","full_name":"hwipl/nuqql-based","owner":"hwipl","description":"Basic network daemon library for nuqql","archived":false,"fork":false,"pushed_at":"2023-09-09T10:56:08.000Z","size":157,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-02T05:23:02.490Z","etag":null,"topics":["daemon","instant-messaging-client","library","network","python"],"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/hwipl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-21T09:15:48.000Z","updated_at":"2022-09-05T06:27:30.000Z","dependencies_parsed_at":"2022-09-14T01:13:52.216Z","dependency_job_id":null,"html_url":"https://github.com/hwipl/nuqql-based","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/hwipl/nuqql-based","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwipl%2Fnuqql-based","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwipl%2Fnuqql-based/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwipl%2Fnuqql-based/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwipl%2Fnuqql-based/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hwipl","download_url":"https://codeload.github.com/hwipl/nuqql-based/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwipl%2Fnuqql-based/sbom","scorecard":{"id":474645,"data":{"date":"2025-08-11","repo":{"name":"github.com/hwipl/nuqql-based","commit":"64397a1bfd6bdf842102bff58209c9cfb9a1248c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/pythonpackage.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/hwipl/nuqql-based/python-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/hwipl/nuqql-based/python-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pythonpackage.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/hwipl/nuqql-based/pythonpackage.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pythonpackage.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/hwipl/nuqql-based/pythonpackage.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:24","Warn: pipCommand not pinned by hash: .github/workflows/pythonpackage.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/pythonpackage.yml:25","Warn: pipCommand not pinned by hash: .github/workflows/pythonpackage.yml:32","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}}]},"last_synced_at":"2025-08-19T14:58:23.782Z","repository_id":57447373,"created_at":"2025-08-19T14:58:23.782Z","updated_at":"2025-08-19T14:58:23.782Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28976334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T09:57:52.632Z","status":"ssl_error","status_checked_at":"2026-02-01T09:57:49.143Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["daemon","instant-messaging-client","library","network","python"],"created_at":"2026-02-01T10:37:40.306Z","updated_at":"2026-02-01T10:37:40.755Z","avatar_url":"https://github.com/hwipl.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nuqql-based\n\nnuqql-based is a basic network daemon library that implements the nuqql\ninterface. It can be used as a dummy backend for\n[nuqql](https://github.com/hwipl/nuqql), e.g., for testing or as a basis for\nthe implementation of other nuqql backends.\n\nOther backends using nuqql-based:\n* [nuqql-slixmppd](https://github.com/hwipl/nuqql-slixmppd): a backend for the\n  XMPP (Jabber) protocol\n* [nuqql-matrixd](https://github.com/hwipl/nuqql-matrixd): a backend for the\n  Matrix protocol\n* [nuqql-matrixd-nio](https://github.com/hwipl/nuqql-matrixd-nio): a backend\n  for the Matrix protocol\n\nDependencies:\n* [daemon](https://pypi.org/project/python-daemon/) (optional): for daemonize\n  support\n\n\n## Setup\n\nYou can install nuqql-based, for example, with pip for your user only with the\nfollowing command:\n\n```console\n$ pip install --user nuqql-based\n```\n\nIf you prefer to check out this repository with git and work with the\nrepository directly, you can install nuqql-based for your user in editable mode\nwith the following command:\n\n```console\n$ pip install --user -e .\n```\n\n\n## Usage\n\nCreating a nuqql backend with the nuqql-based library consists of the steps in\nthe following boilerplate code:\n\n```python\nfrom nuqql_based.based import Based\nfrom nuqql_based.callback import Callback\n\n# create a new backend\nBACKEND_NAME = \"myBackend\"\nBACKEND_VERSION = \"0.1\"\nbased = Based(BACKEND_NAME, BACKEND_VERSION)\n\n# set callbacks\ncallbacks = [\n    # based events\n    (Callback.BASED_CONFIG, based_config),\n    (Callback.BASED_INTERRUPT, based_interrupt),\n    (Callback.BASED_QUIT, based_quit),\n\n    # nuqql messages\n    (Callback.QUIT, stop),\n    (Callback.ADD_ACCOUNT, add_account),\n    (Callback.DEL_ACCOUNT, del_account),\n    (Callback.SEND_MESSAGE, send_message),\n    (Callback.SET_STATUS, set_status),\n    (Callback.GET_STATUS, get_status),\n    (Callback.CHAT_LIST, chat_list),\n    (Callback.CHAT_JOIN, chat_join),\n    (Callback.CHAT_PART, chat_part),\n    (Callback.CHAT_SEND, chat_send),\n    (Callback.CHAT_USERS, chat_users),\n    (Callback.CHAT_INVITE, chat_invite),\n]\nbased.set_callbacks(callbacks)\nbased.start()\n```\n\nYou can omit the callbacks you do not need in the `callbacks` list. In addition\nto the code above, you need to implement the callbacks you specify in your\n`callbacks` list.\n\nThe parameters passed to all callbacks are: the account, the callback and a\ncallback-specific parameter tuple. The following example shows the\n`send_message` callback:\n\n```python\nasync def send_message(account, callback, params):\n    \"\"\"\n    Send a message to another user.\n    \"\"\"\n\n    dest, msg = params\n    # do something with the message...\n\n    return \"\"\n```\n\nThe callbacks are only used for commands coming from nuqql. You must handle\nbackend-specific events like receiving messages from other users in your\nbackend code and optionally pass them to nuqql-based. The following example\nshows how incoming messages from other users can be passed to nuqql-based with\n`Message.message()` and `receive_msg()`:\n\n```python\nfrom nuqql_based.message import Message\n\ndef receive(account, timestamp, sender, destination, text):\n    \"\"\"\n    Receive message from other user.\n    \"\"\"\n\n    msg = Message.message(account, timestamp, sender, destination, text)\n    account.receive_msg(msg)\n```\n\n\n## Changes\n\n* v0.3.0:\n  * Switch to asyncio and increase required Python version to \u003e= 3.7\n  * Remove copy of the buddy list from Account and rename callback\n    `UPDATE_BUDDIES` to `GET_BUDDIES` to match new behaviour\n  * Add callbacks:\n    * `HELP_WELCOME`: welcome/help message for clients\n    * `HELP_ACCOUNT_ADD`: help text for adding accounts\n  * Add configuration option for filtering own messages\n* v0.2.0:\n  * Use only one log file\n  * Add \"push-accounts\" to configuration/command line arguments\n  * Add more info messages and extend output of \"help\" command\n  * Change callback parameter from account id to Account\n  * Add tests\n  * Cleanups and fixes\n* v0.1:\n  * First release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhwipl%2Fnuqql-based","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhwipl%2Fnuqql-based","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhwipl%2Fnuqql-based/lists"}