{"id":17151223,"url":"https://github.com/soda480/progress1bar","last_synced_at":"2026-01-26T03:16:16.302Z","repository":{"id":37796476,"uuid":"391509512","full_name":"soda480/progress1bar","owner":"soda480","description":"A customizable ANSI-based progress bar.","archived":false,"fork":false,"pushed_at":"2025-12-25T01:45:16.000Z","size":3352,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-26T10:47:18.656Z","etag":null,"topics":["progress-bar","progressbar","pybuilder","python","python-mixin"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soda480.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,"zenodo":null}},"created_at":"2021-08-01T02:56:31.000Z","updated_at":"2025-12-25T01:44:02.000Z","dependencies_parsed_at":"2025-04-13T12:02:25.834Z","dependency_job_id":"17d054e2-3b60-4927-99e4-5a78bcc70842","html_url":"https://github.com/soda480/progress1bar","commit_stats":{"total_commits":28,"total_committers":2,"mean_commits":14.0,"dds":0.1785714285714286,"last_synced_commit":"a45bdd6163fcd129fd9c0e353f3cbd922c922531"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/soda480/progress1bar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soda480%2Fprogress1bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soda480%2Fprogress1bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soda480%2Fprogress1bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soda480%2Fprogress1bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soda480","download_url":"https://codeload.github.com/soda480/progress1bar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soda480%2Fprogress1bar/sbom","scorecard":{"id":835723,"data":{"date":"2025-08-11","repo":{"name":"github.com/soda480/progress1bar","commit":"54fbc0605f14aac5657e8a880f395ce7213b90c0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.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/main.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/soda480/progress1bar/main.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:2","Warn: pipCommand not pinned by hash: Dockerfile:6","Warn: pipCommand not pinned by hash: Dockerfile:6","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   2 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":"Code-Review","score":0,"reason":"Found 0/15 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":"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: Apache License 2.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"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 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-23T18:59:31.148Z","repository_id":37796476,"created_at":"2025-08-23T18:59:31.148Z","updated_at":"2025-08-23T18:59:31.148Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28765577,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T02:25:41.078Z","status":"ssl_error","status_checked_at":"2026-01-26T02:24:28.809Z","response_time":59,"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":["progress-bar","progressbar","pybuilder","python","python-mixin"],"created_at":"2024-10-14T21:37:32.081Z","updated_at":"2026-01-26T03:16:16.296Z","avatar_url":"https://github.com/soda480.png","language":"Python","readme":"[![ci](https://github.com/soda480/progress1bar/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/soda480/progress1bar/actions/workflows/ci.yml)\n![Coverage](https://raw.githubusercontent.com/soda480/threaded-order/main/badges/coverage.svg)\n[![PyPI version](https://badge.fury.io/py/progress1bar.svg?icon=si%3Apython)](https://badge.fury.io/py/progress1bar)\n\n# progress1bar\n\nA lightweight, ANSI-based progress bar for terminal output — configurable, readable, and easy to drop into loops or long-running jobs.\n\n## Installation\n```bash\npip install progress1bar\n```\n\n## Quick start\n\nUse ProgressBar as a context manager. Set `total`, then increment `count`.\n\n```Python\nimport time\nfrom progress1bar import ProgressBar\n\nwith ProgressBar(total=250) as pb:\n    for _ in range(pb.total):\n        pb.count += 1\n        time.sleep(0.01)  # simulate work\n```\n\n![example](https://raw.githubusercontent.com/soda480/progress1bar/main/docs/images/example1.gif)\n\n## Showing what’s being processed (`alias`)\n\nIf you want the bar to show the “current item”, set `alias` as you go.  You can also set a custom ticker.\n\n```Python\nimport time\nfrom faker import Faker\nfrom colorama import Fore\nfrom colorama import Style\nfrom progress1bar import ProgressBar\n\nkwargs = {\n    'total': 75,\n    'show_complete': False,\n    'clear_alias': True,\n    'show_duration': False,\n    'ticker': Style.BRIGHT + Fore.RED + chr(9644) + Style.RESET_ALL,\n}\nwith ProgressBar(**kwargs) as pb:\n    for _ in range(pb.total):\n        pb.alias = Faker().name()\n        time.sleep(.08)  # simulate work\n        pb.count += 1\n```\n\n![example](https://raw.githubusercontent.com/soda480/progress1bar/main/docs/images/example2.gif)\n\n## Configuration\n\n```Python\nProgressBar(\n    total=None,\n    fill=None,\n    regex=None,\n    completed_message=None,\n    clear_alias=False,\n    show_fraction=True,\n    show_percentage=True,\n    show_duration=False,\n    show_complete=True,\n    ticker=None,\n    use_color=True,\n    show_bar=True)\n```\n\n| Option              | Type   | What it does                                      | Default                 |\n| ------------------- | ------ | ------------------------------------------------- | ----------------------- |\n| `total`             | `int`  | Total units of work to complete                   | `None`                  |\n| `completed_message` | `str`  | Message shown when complete                       | `\"Processing complete\"` |\n| `show_fraction`     | `bool` | Show `count/total`                                | `True`                  |\n| `show_percentage`   | `bool` | Show percent complete                             | `True`                  |\n| `show_duration`     | `bool` | Print elapsed time after completion               | `False`                 |\n| `show_complete`     | `bool` | Show completion message                           | `True`                  |\n| `use_color`         | `bool` | Alias is displayed in color                       | `True`                  |\n| `show_bar`          | `bool` | Render ticker characters (the “bar” itself)       | `True`                  |\n| `ticker`            | `int` or `str`  | Unicode code point to use as the ticker character - (must be in the range 33–65532). Useful when color output is disabled.\u003cbr\u003eA single character or ANSI-styled string. Intended for colored or styled output.| `9632` (`■`)            |\n\n### Number formatting (`fill`)\n\n`fill` lets you pad the displayed total / count with leading zeros for a consistent look.\n\n```Python\nfill = {\"max_total\": 4, \"max_completed\": 4}\n```\n\n### Regex-driven updates (`regex`)\n\nIf you’d rather drive the progress bar by feeding it messages (instead of setting attributes directly), you can supply regex patterns for total, count, and optionally alias. When a message matches, the captured value is applied.\n\n```Python\nimport random\nfrom faker import Faker\nfrom progress1bar import ProgressBar\n\nkwargs = {\n    \"ticker\": 9733,  # ★\n    \"regex\": {\n        \"total\": r\"^processing total of (?P\u003cvalue\u003e\\d+)$\",\n        \"count\": r\"^processed .*$\",\n        \"alias\": r\"^processor is (?P\u003cvalue\u003e.*)$\",\n    },\n    \"use_color\": False,\n}\n\nwith ProgressBar(**kwargs) as pb:\n    pb.match(f\"processor is {Faker().name()}\")\n    total = random.randint(500, 750)\n    pb.match(f\"processing total of {total}\")\n    for _ in range(total):\n        pb.match(f\"processed {Faker().name()}\")\n```\n\n### Reuse the same progress bar (`reset()`)\n\nIf you want to reuse one ProgressBar instance across multiple runs (and keep track of repeated usage), call:\n\n```Python\npb.reset()\n```\n\n![example](https://raw.githubusercontent.com/soda480/progress1bar/main/docs/images/example4.gif)\n\n### More Examples\n\nThe repo includes multiple runnable examples (including variations like “no bar, just percentage/fraction”, custom tickers, regex matching, and multiple iterations with resets).\n\n## Development\n\nClone the repository and ensure the latest version of Docker is installed on your development server.\n\nBuild the Docker image:\n```sh\ndocker image build \\\n-t progress1bar:latest .\n```\n\nRun the Docker container:\n```sh\ndocker container run \\\n--rm \\\n-it \\\n-v $PWD:/code \\\nprogress1bar:latest \\\nbash\n```\n\nExecute the build:\n```sh\nmake dev\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoda480%2Fprogress1bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoda480%2Fprogress1bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoda480%2Fprogress1bar/lists"}