{"id":13617095,"url":"https://github.com/sopel-irc/sopel","last_synced_at":"2025-12-16T19:03:02.734Z","repository":{"id":2095084,"uuid":"3035586","full_name":"sopel-irc/sopel","owner":"sopel-irc","description":":robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.","archived":false,"fork":false,"pushed_at":"2025-11-14T03:35:06.000Z","size":9731,"stargazers_count":968,"open_issues_count":173,"forks_count":408,"subscribers_count":55,"default_branch":"master","last_synced_at":"2025-11-14T05:32:52.928Z","etag":null,"topics":["hacktoberfest","irc","irc-bot","irc-bot-framework","python"],"latest_commit_sha":null,"homepage":"https://sopel.chat","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sopel-irc.png","metadata":{"files":{"readme":"README.rst","changelog":"NEWS","contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["sopel-irc","dgw"],"open_collective":"sopel"}},"created_at":"2011-12-22T17:59:00.000Z","updated_at":"2025-11-14T03:31:43.000Z","dependencies_parsed_at":"2024-01-01T05:07:01.545Z","dependency_job_id":"fd2bc195-3603-4b6a-b568-b8af8e1ac339","html_url":"https://github.com/sopel-irc/sopel","commit_stats":{"total_commits":4910,"total_committers":182,"mean_commits":"26.978021978021978","dds":0.7545824847250509,"last_synced_commit":"ab32aca08f7bf67d1ba754fdfc22a10ee5a442d0"},"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"purl":"pkg:github/sopel-irc/sopel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sopel-irc%2Fsopel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sopel-irc%2Fsopel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sopel-irc%2Fsopel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sopel-irc%2Fsopel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sopel-irc","download_url":"https://codeload.github.com/sopel-irc/sopel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sopel-irc%2Fsopel/sbom","scorecard":{"id":344616,"data":{"date":"2025-08-11","repo":{"name":"github.com/sopel-irc/sopel","commit":"3db48c3a9a38d89ec8551fe8da9bb9bd97a657a6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.5,"checks":[{"name":"Code-Review","score":9,"reason":"Found 12/13 approved changesets -- score normalized to 9","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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:18","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:19","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/codeql.yml:1","Warn: no topLevel permission defined: .github/workflows/pypi.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":"Maintained","score":10,"reason":"30 commit(s) and 6 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"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":"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":"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/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/codeql.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/sopel-irc/sopel/pypi.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:37","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:40","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:41","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:46","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:68","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yml:20","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   7 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":"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":9,"reason":"license file detected","details":["Info: project has a license file: COPYING:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/pypi.yml:9"],"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":"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"}},{"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":"Branch-Protection","score":-1,"reason":"internal error: error during GetBranch(8.0.x): error during branchesHandler.query: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"SAST","score":8,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 14 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T06:45:17.862Z","repository_id":2095084,"created_at":"2025-08-18T06:45:17.862Z","updated_at":"2025-08-18T06:45:17.862Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27769800,"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","status":"online","status_checked_at":"2025-12-16T02:00:10.477Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["hacktoberfest","irc","irc-bot","irc-bot-framework","python"],"created_at":"2024-08-01T20:01:36.891Z","updated_at":"2025-12-16T19:03:02.710Z","avatar_url":"https://github.com/sopel-irc.png","language":"Python","funding_links":["https://github.com/sponsors/sopel-irc","https://github.com/sponsors/dgw","https://opencollective.com/sopel","https://opencollective.com/sopel/expenses"],"categories":["Python"],"sub_categories":[],"readme":"=======\n Sopel\n=======\n\n|version| |build| |issues| |coverage-status| |license|\n\nIntroduction\n------------\n\nSopel is a simple, lightweight, open source, easy-to-use IRC Utility bot,\nwritten in Python. It's designed to be easy to use, run and extend.\n\nInstallation\n------------\n\nLatest stable release\n=====================\nOn most systems where you can run Python, the best way to install Sopel is to\ninstall `pip \u003chttps://pypi.org/project/pip/\u003e`_ and then ``pip install sopel``.\n\nArch users can install the ``sopel`` package from the [community] repository,\nthough new versions might take slightly longer to become available.\n\nFailing both of those options, you can grab the latest tarball `from GitHub\n\u003chttps://github.com/sopel-irc/sopel/releases/latest\u003e`_  and follow the steps\nfor installing from the latest source below.\n\nLatest source\n=============\nFirst, either clone the repository with ``git clone\nhttps://github.com/sopel-irc/sopel.git`` or download a `source archive from\nGitHub \u003chttps://github.com/sopel-irc/sopel/archive/refs/heads/master.zip\u003e`_.\n\nNote: Sopel requires Python 3.8+ to run.\n\nIn the source directory (whether cloned or from the tarball) run ``pip install\n-e .``. You can then run ``sopel`` to configure and start the bot.\n\nDatabase support\n----------------\nSopel leverages SQLAlchemy to support the following database types: SQLite,\nMySQL, PostgreSQL, MSSQL, Oracle, Firebird, and Sybase. By default Sopel will\nuse a SQLite database in the current configuration directory, but alternative\ndatabases can be configured with the following config options: ``db_type``,\n``db_filename`` (SQLite only), ``db_driver``, ``db_user``, ``db_pass``,\n``db_host``, ``db_port``, and ``db_name``. You will need to manually install\nany packages (system or ``pip``) needed to make your chosen database work.\n\n**Note:** Plugins not updated since Sopel 7.0 was released *might* have\nproblems with database types other than SQLite (but many will work just fine).\n\nAdding plugins\n--------------\nThe easiest place to put new plugins is in ``~/.sopel/plugins``. Some newer\nplugins are installable as packages; `search PyPI\n\u003chttps://pypi.org/search/?q=%22sopel%22\u003e`_ for these. Many more plugins\nwritten by other users can be found using your favorite search engine.\n\nSome older, unmaintained plugins are available in the\n`sopel-extras \u003chttps://github.com/sopel-irc/sopel-extras\u003e`_ repository, but of\ncourse you can also write your own. A `tutorial \u003chttps://sopel.chat/tutorials/part-1-writing-plugins/\u003e`_\nfor creating new plugins is available on Sopel's website.\nAPI documentation can be found online at https://sopel.chat/docs/, or\nyou can create a local version by running ``make docs``.\n\nFurther documentation\n---------------------\n\nThe `official website \u003chttps://sopel.chat/\u003e`_ includes such valuable information\nas a full listing of built-in `commands \u003chttps://sopel.chat/usage/commands/\u003e`_,\n`tutorials \u003chttps://sopel.chat/tutorials/\u003e`_, `API documentation \u003chttps://sopel.chat/docs/\u003e`_,\nand other `usage information \u003chttps://sopel.chat/usage/\u003e`_.\n\nQuestions?\n----------\n\nJoin us in `#sopel \u003circ://irc.libera.chat/#sopel\u003e`_ on Libera Chat.\n\nDonations\n---------\n\nWe're thrilled that you want to support the project!\n\nYou can `sponsor Sopel \u003chttps://github.com/sponsors/sopel-irc\u003e`_ here on\nGitHub or donate through `Open Collective \u003chttps://opencollective.com/sopel\u003e`_.\n\nAny donations received will be used to cover infrastructure costs, such as our\ndomain name and hosting services. Our main project site is easily hosted by\n`Netlify \u003chttps://www.netlify.com/\u003e`_, but we are considering building a few\nnew features that would require more than static hosting. All project-related\n`expenses \u003chttps://opencollective.com/sopel/expenses\u003e`_ are tracked on our\nOpen Collective profile, for transparency.\n\n.. |version| image:: https://img.shields.io/pypi/v/sopel.svg\n   :target: https://pypi.python.org/pypi/sopel\n.. |build| image:: https://github.com/sopel-irc/sopel/actions/workflows/ci.yml/badge.svg?branch=master\u0026event=push\n   :target: https://github.com/sopel-irc/sopel/actions/workflows/ci.yml?query=branch%3Amaster+event%3Apush\n.. |issues| image:: https://img.shields.io/github/issues/sopel-irc/sopel.svg\n   :target: https://github.com/sopel-irc/sopel/issues\n.. |coverage-status| image:: https://coveralls.io/repos/github/sopel-irc/sopel/badge.svg?branch=master\n   :target: https://coveralls.io/github/sopel-irc/sopel?branch=master\n.. |license| image:: https://img.shields.io/pypi/l/sopel.svg\n   :target: https://github.com/sopel-irc/sopel/blob/master/COPYING\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsopel-irc%2Fsopel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsopel-irc%2Fsopel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsopel-irc%2Fsopel/lists"}