{"id":39954243,"url":"https://github.com/matt2000/cfeconfig","last_synced_at":"2026-01-18T20:34:32.120Z","repository":{"id":62561515,"uuid":"237117406","full_name":"matt2000/cfeconfig","owner":"matt2000","description":"Configure Python applications using CLI, Config File, or Environment.","archived":false,"fork":false,"pushed_at":"2020-07-31T21:49:13.000Z","size":31,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-06T18:25:54.225Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/matt2000.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-01-30T01:30:09.000Z","updated_at":"2020-07-31T21:49:15.000Z","dependencies_parsed_at":"2022-11-03T15:15:59.948Z","dependency_job_id":null,"html_url":"https://github.com/matt2000/cfeconfig","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/matt2000/cfeconfig","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt2000%2Fcfeconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt2000%2Fcfeconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt2000%2Fcfeconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt2000%2Fcfeconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matt2000","download_url":"https://codeload.github.com/matt2000/cfeconfig/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt2000%2Fcfeconfig/sbom","scorecard":{"id":625489,"data":{"date":"2025-08-11","repo":{"name":"github.com/matt2000/cfeconfig","commit":"39e0ad4f663b5c4f6333bdaae97b6cee3899d359"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/18 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":"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":-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":"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":"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":"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":"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":"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":"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":"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"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2020-92 / GHSA-hj5v-574p-mj7c","Warn: Project is vulnerable to: PYSEC-2022-42969","Warn: Project is vulnerable to: PYSEC-2020-96 / GHSA-6757-jp84-gxfx","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4","Warn: Project is vulnerable to: GHSA-jfmj-5v4g-7637"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T06:18:53.605Z","repository_id":62561515,"created_at":"2025-08-21T06:18:53.605Z","updated_at":"2025-08-21T06:18:53.605Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28549862,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T19:56:05.265Z","status":"ssl_error","status_checked_at":"2026-01-18T19:55:54.685Z","response_time":98,"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":[],"created_at":"2026-01-18T20:34:32.017Z","updated_at":"2026-01-18T20:34:32.109Z","avatar_url":"https://github.com/matt2000.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CFEconfig\n\nThis module exists to support the 12-factor App approach to configuration,\nwhile also supporting convenient CLIs. This provides overlapping\nfunctionality with the `click` module, so you may not need this if you're\nalready using click, though by using both modules, you may benefit from our\ndistinct way of handling of config files and environment variables.\n\nYou can specify your configurable options in 3 ways, in any combination:\n - Via environment variables named as 'PREFIX_OPTION_NAME' where prefix is a\n string you choose to identify the application instance.\n - Via a YAML format configuration file of key-value pairs.\n - Via arguments to your main script.\n\nIf the same option is specified in more than one place,\nCLI options take precendence over Config File options which take\nprecendence over Environment Variables. This rule is the origin of the\npackage name: CFE = CLI-\u003eFile-\u003eEnvironment.\n\nFurther, and unlike `click`, we push CLI and File-based options into the\nEnvironment, so that applications and modules which do not use this module\ncan still read them. Code that does call `config.get`, will receive immutable\nvalues representing the state of the Environment variables *at the time of\nprogram start-up[1]* , regardless of what has happened to environment\nvariables since.\n\nWe assume, but do not require, the use of the `docopt` module to handle\nconfiguration via command-line arguments. Any dict[str, str] of config values\nwill do, if you prefer to use alternate argument parsing.\n\n## Typical usage\n\n1. Read command-line args first, e.g., `opts = docopt.docopt(__doc__)`\n2. Read and store environment variables, with\n`config.load(opts, 'some_env_var_prefix')`.\n3. Throughout the application, use `config.get()` to get a dict of\nconfiguration values or `config.get('option_name')` to get a specific option value.\n\n```python\n    \"\"\"Usage: myapp.py [--foo] [--bar]\"\"\"\n    from cfeconfig import config\n    from docopt import docopt\n\n    from mylib import myfunction\n\n    opts = docopt(__doc__)\n    config.load(opts, 'myapp', 'config.yml')  # Push opts to Environment.\n    CONFIG = config.get()\n    myfunction(CONFIG)\n```\n\n\nSee DocTests in module functions for examples.\n\n\n## Theoretical Example usage with `click`\n\n```python\n    import os\n\n    from click import click\n    from cfeconfig import config\n\n    @click.command\n    @click.option('--a')\n    @click.option('--b')\n    def cli(**kwargs):\n        config.load(kwargs, 'myapp')\n        do_stuff()  # More likely we're calling some code in our library.\n\n    def do_stuff():\n        CONFIG = config.get()\n        assert CONFIG['A'] == os.environ['MYAPP_A']\n\n    if __name__ == '__main__':\n        cli()\n```\n\n[1] More precisely, at the time config.load() was called.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatt2000%2Fcfeconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatt2000%2Fcfeconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatt2000%2Fcfeconfig/lists"}