{"id":34043007,"url":"https://github.com/not-so-cool-anymore/plugypy","last_synced_at":"2026-04-09T00:31:06.840Z","repository":{"id":57453677,"uuid":"272809974","full_name":"not-so-cool-anymore/plugypy","owner":"not-so-cool-anymore","description":"Lightweight and flexible plugin framework for Python. ","archived":false,"fork":false,"pushed_at":"2021-11-01T14:11:30.000Z","size":53,"stargazers_count":14,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-03T03:59:26.727Z","etag":null,"topics":["lightweight","lightweight-framework","plugin-manager","plugin-system","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/not-so-cool-anymore.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":"2020-06-16T20:53:14.000Z","updated_at":"2024-07-11T22:04:04.000Z","dependencies_parsed_at":"2022-08-29T06:51:41.017Z","dependency_job_id":null,"html_url":"https://github.com/not-so-cool-anymore/plugypy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/not-so-cool-anymore/plugypy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-so-cool-anymore%2Fplugypy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-so-cool-anymore%2Fplugypy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-so-cool-anymore%2Fplugypy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-so-cool-anymore%2Fplugypy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/not-so-cool-anymore","download_url":"https://codeload.github.com/not-so-cool-anymore/plugypy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-so-cool-anymore%2Fplugypy/sbom","scorecard":{"id":694809,"data":{"date":"2025-08-11","repo":{"name":"github.com/not-so-cool-anymore/plugypy","commit":"2171d9f9367a6190aacaecc85f73a19087cc5ef7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"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":"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":"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: 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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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"}}]},"last_synced_at":"2025-08-22T03:22:25.514Z","repository_id":57453677,"created_at":"2025-08-22T03:22:25.514Z","updated_at":"2025-08-22T03:22:25.514Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31579810,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["lightweight","lightweight-framework","plugin-manager","plugin-system","python"],"created_at":"2025-12-13T22:55:08.681Z","updated_at":"2026-04-09T00:31:06.813Z","avatar_url":"https://github.com/not-so-cool-anymore.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PlugyPy\n![plugypy](https://socialify.git.ci/not-so-cool-anymore/plugypy/image?description=1\u0026descriptionEditable=PlugyPy%20is%20a%20lightweight%20Python%20plugin%20system.%20It%20allows%20executing%20Python%20in%20the%20form%20of%20plugins%20during%20program%27s%20runtime.\u0026font=KoHo\u0026language=1\u0026owner=1\u0026pattern=Circuit%20Board\u0026stargazers=1\u0026theme=Dark)\n\n## Installation\nYou can install the plugin system from PyPi with:\n\n```\npip install PlugyPy\n```\n\nOr locally by cloning the repository:\n\n```\ngit clone https://github.com/not-so-cool-anymore/plugypy.git\n```\nand then running the setup file in the main directory with:\n```\npip install .\n```\n\n## Writing a configuration file\nA PlugyPy configuration (or config) file is a JSON file that contains a deserialized representation of a PlugyPy `Configuration` object.\nThe `Configuration` object consists of a boolean named `will_load_all` and a list named `plugins`.\n`plugins` is a list of PlugyPy `Plugin` objects  `will_load_all` determines whether all of the plugins in the plugins directory will be loaded or only the enabled ones.\n\nAn example of a config file is:\n```json\n{\n    \"will_load_all\": true,\n    \"plugins\": [\n        {\n            \"name\": \"example_plugin_name_0\",\n            \"is_enabled\": true\n        },\n        {\n            \"name\": \"example_plugin_name_1\",\n            \"is_enabled\": false\n        },\n        {\n            \"name\": \"example_plugin_name_2\",\n            \"is_enabled\": true\n        }\n    ] \n}\n```\n\nWhere `name` is the name of the plugin file without the `.py` file extension, and `enabled` is the boolean variable that indicates whether a plugin will be loaded (when `true`) or not (when `false`).\n\n## Usage\nImporting the plugin system:\n```python\nimport plugypy\n```\n\n\nDeserializing JSON configuration file into a `Configuration` object.\n```python\nconfiguration_deserializer = ConfigurationDeserializer('/path/to/configuration/file')\nconfiguration = configuration_deserializer.deserialize_config()\n```\n\n\nCreating a plugin manager object:\n```python\nplugin_manager = plugypy.PluginManager('/path/to/plugins/directory', configuration)\n```\nThe plugin manager object has one extra feature - plugin ownership verification. This feature ensures that the plugin that is being executed\nbelongs to the current user (or if `sudo` is used to run the program - the `sudo` caller).\nThis feature can be activated via parsing one extra argument - `will_verify_ownership=True`, which is set to `False` by default when not passed.\n\n\nDiscovering plugins:\n```python\ndiscovered_plugins = plugin_manager.discover_plugins()\n```\n`discover_plugins` is a list of all the plugins in a given plugins directory.\n\n\nImporting plugins:\n```python\nplugins_list = plugin_manager.import_plugins(discovered_plugins)\n```\n`plugins_list` is a list of map objects that has a `name` key and an `object` value of the imported executable Python module (plugin executable).\n\n\nImporting a singe plugin by file name:\n```python\nsingle_plugin = plugin_manager.import_plugin('PLUGIN_FILENAME_WITHOUT_PY_EXTENSION')\n```\nIn this case, the plugin will be imported no matter if a configuration for it exists. This importing method is developed for edge cases in which the imported plugin will be\nexecuted only once.\n\n\nGetting a plugin's information:\n```python\nplugin_name = plugins_list[n]['name']\nplugin_executable_object = plugins_list[n]['object']\n```\n`n` is an index of a plugin.\n\n\nExecuting a plugin's function with no parameters:\n```python\nplugin = plugins_list[n]\nplugin_result = plugin_manager.execute_plugin_function(plugin, 'function_name')\n\nif plugin_result == None:\n    print('The plugin returned no result')\nelse:\n    print('The plugin returned: {}'.format(result))\n```\n`n` is an index of a plugin.\n\n\nExecuting a plugin's function with parameters:\n```python\nplugin = plugins_list[n]\n\narguments_tuple = ('arg1', 'arg2', 'arg3')\nplugin_result = plugin_manager.execute_plugin_function(plugin, 'function_name', args=arguments_tuple)\n\nif plugin_result == None:\n    print('The plugin returned no result')\nelse:\n    print('The plugin returned: {}'.format(result))\n```\n`n` is an index of a plugin.\n\n`args` must be a tuple of argument/s.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnot-so-cool-anymore%2Fplugypy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnot-so-cool-anymore%2Fplugypy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnot-so-cool-anymore%2Fplugypy/lists"}