{"id":43756110,"url":"https://github.com/frozflame/volkanic","last_synced_at":"2026-02-05T14:30:39.976Z","repository":{"id":62587780,"uuid":"155803553","full_name":"frozflame/volkanic","owner":"frozflame","description":"Interface with config files and shell prompts easily and elegantly.","archived":false,"fork":false,"pushed_at":"2025-10-02T08:03:07.000Z","size":147,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-18T18:36:19.816Z","etag":null,"topics":["python","subcommand"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/volkanic/","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/frozflame.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-02T02:29:08.000Z","updated_at":"2025-10-02T08:03:12.000Z","dependencies_parsed_at":"2024-06-24T02:39:00.922Z","dependency_job_id":null,"html_url":"https://github.com/frozflame/volkanic","commit_stats":{"total_commits":144,"total_committers":1,"mean_commits":144.0,"dds":0.0,"last_synced_commit":"c6bc4e9eaf815fdbff61682c33728412eaa0aaa8"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/frozflame/volkanic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frozflame%2Fvolkanic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frozflame%2Fvolkanic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frozflame%2Fvolkanic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frozflame%2Fvolkanic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frozflame","download_url":"https://codeload.github.com/frozflame/volkanic/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frozflame%2Fvolkanic/sbom","scorecard":{"id":412377,"data":{"date":"2025-08-11","repo":{"name":"github.com/frozflame/volkanic","commit":"04f9d1b7df04088f5d226f7b9d88b3210900fbc4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"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":"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":"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":"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":"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":"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":"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: 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 '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"}}]},"last_synced_at":"2025-08-18T23:02:45.788Z","repository_id":62587780,"created_at":"2025-08-18T23:02:45.788Z","updated_at":"2025-08-18T23:02:45.788Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29123675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T14:05:12.718Z","status":"ssl_error","status_checked_at":"2026-02-05T14:03:53.078Z","response_time":65,"last_error":"SSL_read: 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":["python","subcommand"],"created_at":"2026-02-05T14:30:38.499Z","updated_at":"2026-02-05T14:30:39.968Z","avatar_url":"https://github.com/frozflame.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"volkanic\n========\n\nInterface with config files and shell prompts easily and elegantly.\n\nTo install (add `sudo` if necessary)\n\n    python3 -m pip install volkanic\n\nPython version requirement (plan)\n\n    0.5.0   Python 3.5+\n    0.6.0   Python 3.6+\n    0.7.0   Python 3.7+\n    0.8.0   Python 3.8+\n    0.9.0   Python 3.9+\n\n### GlobalInterface and config file\n\nExample:\n\n`GlobalInterface` is defined in `example/environ.py` as:\n\n```python\nimport volkanic\n\n\nclass GlobalInterface(volkanic.GlobalInterface):\n    # you should always define `package_name`\n    package_name = 'example'\n```\n\nConfiguration file `config.json5`:\n\n```json5\n{\n    \"upstram_prefix\": \"http://127.0.0.1:9100\",\n    \"sqlite\": \"/data/local/example/db.sqlite\"\n}\n```\n\nThis `config.json5` is at one of the follow locations:\n\n- Under your project directory in a development enviornment\n- `~/.example/config.json5`\n- `/etc/example/config.json5`\n- `/example/config.json5`\n\nAccess config:\n\n```\n\u003e\u003e\u003e from example.environ import GlobalInterface \n\u003e\u003e\u003e gi = GlobalInterface()  # note that GlobalInterface is a sington class\n\u003e\u003e\u003e print(gi.conf)\n{'upstram_prefix': 'http://127.0.0.1:9100', 'sqlite': '/data/local/example/db.sqlite'}\n```\n\nNote that `GlobalInterface` is a singlon class, which means that\n`GlobalInterface()` will always return the same object:\n\n```\n\u003e\u003e\u003e GlobalInterface() is GlobalInterface()\nTrue\n```\n\nThe recommended usage of `GlobalInterface()` is to create instanciate it\nat the top each module:\n\n```python\nfrom example.environ import GlobalInterface  # noqa\nfrom example.tools import your_funny_tool  # noqa\n\ngi = GlobalInterface()\n\n\ndef find_funny_things():\n    url = gi.conf['upstram_prefix'] + '/funny-api'\n    path = gi.under_package_dir('asset/funny.json')\n    # more code here ...\n```\n\n-------------------------------------------------------------------------\n\n### Accessories\n\nList sub-commands\n\n    $ volk\n    availabe commands:\n    - a\n    - o\n    - runconf\n    - where\n\nLocate a Python package directory with `volk where`:\n\n    $ volk where requests\n    requests\t/usr/local/lib/python3.6/site-packages/requests\n\nYou can open a file or URL with default application with `volk o`.\n\nTo open current directory with default file manager (Finder / explorer.exe / ...)\n\n    $ volk o .\n\nShow `sys.argv`:\n\n    $ volk a \\; \"hello world\" hello python\n    0\t'/usr/local/bin/volk'\n    1\t'a'\n    2\t';'\n    3\t'hello world'\n    4\t'hello'\n    5\t'python'\n\n-------------------------------------------------------------------------\n\n### Sub-command protocal\n\nSay you have a package named `mypkg`\n\n    mypkg/\n    ├── MANIFEST.in\n    ├── docs/\n    ├── mypkg/\n    │    ├── __init__.py\n    │    ├── algors.py\n    │    ├── formatters.py\n    │    ├── main.py\n    │    └── parsers.py\n    ├── requirements.txt\n    ├── setup.py\n    └── tests/\n\nIn one of your functional modules, e.g. `mypkg/mypkg/formatter.py`,\nprovide a entry function which takes exactly 2 arguments:\n\n```python\nimport argparse\n\n\ndef process_file(path):\n    # actual code here\n    return\n\n\ndef run(prog=None, args=None):\n    desc = 'human readable formatter'\n    parser = argparse.ArgumentParser(prog=prog, description=desc)\n    add = parser.add_argument\n    add('-i', '--input-file', help='path to your input file')\n    ns = parser.parse_args(args)\n    process_file(ns.input_file)\n```\n\nSub-command registry in `mypkg/mypkg/main.py`:\n\n```python\nimport volkanic\n\ncommands = {\n    \"fmt\": \"mypkg.formatter\",\n    \"yml\": \"mypkg.parsers:run_yml_parser\",\n    \"ini\": \"mypkg.parsers:run_ini_parser\",\n}\nregistry = volkanic.CommandRegistry(commands)\n```\n\nNote that `mypkg.formatter` is a shorthand for `mypkg.formatter:run`.\n\nConfigure top level command in `mypkg/setup.py`:\n\n```python\nfrom setuptools import setup\n\nsetup(\n    name=\"mypkg\",\n    entry_points={\"console_scripts\": [\"mycmd = mypkg.main:registry\"]},\n    # more arguments here\n)\n```\n\nInstall package `mypkg` or link with `python3 setup.py develop`.\n\nNow you have command `mycmd`:\n\n    $ mycmd\n    availabe commands:\n    - fmt\n    - ini\n    - yml\n\nRun with sub-command `fmt`:\n\n    $ mycmd fmt -h\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrozflame%2Fvolkanic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrozflame%2Fvolkanic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrozflame%2Fvolkanic/lists"}