{"id":13937651,"url":"https://github.com/glvnst/usersettings","last_synced_at":"2026-02-07T00:19:30.051Z","repository":{"id":55863734,"uuid":"9755157","full_name":"glvnst/usersettings","owner":"glvnst","description":"Portable Local Settings Storage for Python","archived":false,"fork":false,"pushed_at":"2020-12-10T20:10:39.000Z","size":31,"stargazers_count":30,"open_issues_count":5,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-02T05:26:51.144Z","etag":null,"topics":["appdirs","configparser","python","usersettings"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/usersettings/","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/glvnst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-29T18:36:26.000Z","updated_at":"2025-08-30T20:31:19.000Z","dependencies_parsed_at":"2022-08-15T08:00:57.985Z","dependency_job_id":null,"html_url":"https://github.com/glvnst/usersettings","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/glvnst/usersettings","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glvnst%2Fusersettings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glvnst%2Fusersettings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glvnst%2Fusersettings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glvnst%2Fusersettings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glvnst","download_url":"https://codeload.github.com/glvnst/usersettings/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glvnst%2Fusersettings/sbom","scorecard":{"id":430445,"data":{"date":"2025-08-11","repo":{"name":"github.com/glvnst/usersettings","commit":"1a32179784f3a7c5e3506e04f5e315ac82acde5a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"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":"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":"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":"Code-Review","score":0,"reason":"Found 1/29 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":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-package.yml:1","Warn: no topLevel permission defined: .github/workflows/python-publish.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-package.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/glvnst/usersettings/python-package.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/glvnst/usersettings/python-package.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/glvnst/usersettings/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/glvnst/usersettings/python-publish.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:28","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:33","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:34","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:24","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":"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":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt: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":"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":-1,"reason":"internal error: error during branchesHandler.setup: 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":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 10 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-19T03:12:43.026Z","repository_id":55863734,"created_at":"2025-08-19T03:12:43.027Z","updated_at":"2025-08-19T03:12:43.027Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29181326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T23:15:33.022Z","status":"ssl_error","status_checked_at":"2026-02-06T23:15:09.128Z","response_time":59,"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":["appdirs","configparser","python","usersettings"],"created_at":"2024-08-07T23:03:45.449Z","updated_at":"2026-02-07T00:19:30.030Z","avatar_url":"https://github.com/glvnst.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# usersettings\n\n## Portable Local Settings Storage for Python\n\n- Automatic storage of settings information in a simple flat text file ([ConfigParser][] format)\n- Automatically stored in an OS-appropriate location (via [appdirs][]). For example, with the chosen app identifier `com.example.apps.demo`:\n\n    |     OS    | Settings File Location                                                                                       |\n    | :-------: | ------------------------------------------------------------------------------------------------------------ |\n    | macOS     | `~/Library/Application Support/com.example.apps.demo/settings.cfg`                                           |\n    | GNU/Linux | `~/.config/com.example.apps.demo/settings.cfg`                                                               |\n    | Windows   | `C:\\Documents and Settings\\\u003cUser\u003e\\Application Data\\com.example.apps.demo\\com.example.apps.demo\\settings.cfg` |\n\n- Interface modeled on the [argparse][] module.\n\n## Installation \n\nTo install this package, run: `pip install usersettings`\n\nYou can also download builds of [usersettings on the Python Package Index](https://pypi.org/project/usersettings/).\n\n## Example:\n\nThe following example code shows the entire interface. This program will change its output each time it is run.\n\n```python\n#!/usr/bin/python\n\"\"\" test usersettings \"\"\"\nimport time\nimport usersettings\n\n# Identify for your app\ns = usersettings.Settings(\"com.example.apps.demo\")\n\n# specify what settings you have\ns.add_setting(\"counter\", int, default=0)\ns.add_setting(\"animal\", str, default=\"turtles\")\ns.add_setting(\"runtimes\", list, [])\n\n# load any previously-saved values for those\ns.load_settings()\n\n# use those values\ns.counter += 1\nif s.counter \u003e 2:\n    # Tired of turtles?\n    s.animal = \"the Rabbit of Caerbannog\"\ns.runtimes.append(time.time())\n\n# save your changes\ns.save_settings()\n\nprint(\n    (\n        \"I've run {0.counter} time(s). \"\n        \"I like {0.animal}! \"\n        \"I've been launched at these times: {0.runtimes!s}\"\n    ).format(s)\n)\n```\n\nRunning this demo on a mac:\n\n```\n$ python examples/demo.py \nI've run 1 time(s). I like turtles! I've been launched at these times: [1607277627.5897138]\n\n$ python examples/demo.py \nI've run 2 time(s). I like turtles! I've been launched at these times: [1607277627.5897138, 1607277630.170041]\n\n$ python examples/demo.py \nI've run 3 time(s). I like the Rabbit of Caerbannog! I've been launched at these times: [1607277627.5897138, 1607277630.170041, 1607277631.320534]\n\n$ cat ~/Library/Application\\ Support/com.example.apps.demo/settings.cfg \n[settings]\ncounter = 3\nanimal = the Rabbit of Caerbannog\nruntimes = [1607277627.5897138, 1607277630.170041, 1607277631.320534]\n```\n\n## License\n\nThis module is licensed under a BSD-style licence. See [LICENSE.txt](LICENSE.txt) for details.\n\n## Notes\n\n- Uses the [appdirs][] module from pypi. \n- Created after asking this [question on stack overflow](http://stackoverflow.com/questions/16275031/portable-settings-and-app-data-storage-in-python)\n- `usersettings` not your cup of tea? Have a look at [configmgr](https://bitbucket.org/grantor61/configmgr), an earlier project which also leverages appdirs\n\n[ConfigParser]: http://docs.python.org/2/library/configparser.html\n[argparse]: http://docs.python.org/2/library/argparse.html\n[appdirs]: https://pypi.python.org/pypi/appdirs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglvnst%2Fusersettings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglvnst%2Fusersettings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglvnst%2Fusersettings/lists"}