{"id":19949839,"url":"https://github.com/tfiers/coblack","last_synced_at":"2025-10-07T07:28:37.495Z","repository":{"id":62563210,"uuid":"306878274","full_name":"tfiers/coblack","owner":"tfiers","description":"Black-compliant formatter/rewrapper for Python comments","archived":false,"fork":false,"pushed_at":"2020-10-28T22:32:50.000Z","size":87,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-23T09:24:27.873Z","etag":null,"topics":["black","comments","formatter","python","wrap"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tfiers.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-10-24T12:25:31.000Z","updated_at":"2020-10-28T22:32:52.000Z","dependencies_parsed_at":"2022-11-03T15:31:14.215Z","dependency_job_id":null,"html_url":"https://github.com/tfiers/coblack","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tfiers/coblack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfiers%2Fcoblack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfiers%2Fcoblack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfiers%2Fcoblack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfiers%2Fcoblack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tfiers","download_url":"https://codeload.github.com/tfiers/coblack/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfiers%2Fcoblack/sbom","scorecard":{"id":875850,"data":{"date":"2025-08-11","repo":{"name":"github.com/tfiers/coblack","commit":"68e6c88a2c6586d2b676b79f07849dd85e0554f0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"Code-Review","score":0,"reason":"Found 0/9 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":"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":"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":"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: MIT License: 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-24T05:57:56.711Z","repository_id":62563210,"created_at":"2025-08-24T05:57:56.711Z","updated_at":"2025-08-24T05:57:56.711Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278739935,"owners_count":26037474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["black","comments","formatter","python","wrap"],"created_at":"2024-11-13T00:47:38.014Z","updated_at":"2025-10-07T07:28:37.465Z","avatar_url":"https://github.com/tfiers.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coblack\n\n_Coblack_ is a \u003cem\u003e\u003ca href=\"https://black.readthedocs.io\"\u003eBlack\u003c/a\u003e\u003c/em\u003e-compliant formatter/rewrapper for Python comments.\n\n\n#### Example code\n\nBefore:\n```python\ndef care_for(self, favorite_plant):\n    self.sing_a_lullaby_to(favorite_plant)  # This should help them grow. Note that this comment is too long to fit on one line, given the recommended line length.\n    favorite_plant.water(100 * mL)  # Prevent dehydration.\n```\n\nAfter:\n```python\ndef care_for(self, favorite_plant):\n    self.sing_a_lullaby_to(favorite_plant)  # This should help them grow. Note that this\n    #                                       # comment is too long to fit on one line,\n    #                                       # given the recommended line length.\n    favorite_plant.water(100 * mL)  # Prevent dehydration.\n```\nThe extra `#`'s at the beginning of each line are necessary to be Black-compliant:\\\nIf they were not there, Black would pull the comments to the start of the line, \ndestroying the alignment, and making the code look messier.\n(Compare to how the [naive way](#naive-way-of-wrapping-comments) of wrapping comments looks).\n\n\n\u003cbr\u003e\n\n\n## Installation\n\n```\n$ pip install coblack\n```\n\nThis will get you the [![latest release on PyPI](https://img.shields.io/pypi/v/coblack.svg?label=latest%20release%20on%20PyPI:)](https://pypi.python.org/pypi/coblack/)\n\n(Upgrade an existing installation of Coblack by adding the `--upgrade`/`-U` flag).\n\n\n\u003cbr\u003e\n\n\n## Usage\n\nIn your terminal:\n```\n$ coblack my_file.py\n```\nThis wraps \u0026 fills out multiline comments, and passes the result through `black`.\\\nThe file is edited in-place.\n\nGet info on additional options (such as eg `-l` to set the line length) \nwith `coblack -h`.\n\n\n\u003cbr\u003e\n\n\n## IDE integration\n\nFor PyCharm, create a new [_External Tool_](https://www.jetbrains.com/help/pycharm/configuring-third-party-tools.html),\nas follows:\n\n\u003cimg alt='Screenshot of External Tool UI in PyCharm. Gist: `coblack \"$FilePath$\"`'\n     src='doc/IDE_integration_PyCharm.png'\n     width=600\u003e\n\nThen assign a keyboard shortcut to this tool.\\\nThis enables you to format your files quickly and often during coding sessions.\n\nIn VS Code, you'd create a new [_Task_](https://code.visualstudio.com/docs/editor/tasks), in a similar fashion.\n\n\n\u003cbr\u003e\n\n\n## Python API\n\n```python\nimport coblack\n\ncoblack.format_file(\"path/to/my_file.py\")  # You can also pass a `pathlib.Path`.\n```\n\n\n\u003cbr\u003e\n\n\n## Appendix\n\n#### Naive way of wrapping comments\n\n```python\ndef care_for(self, favorite_plant):\n    self.sing_a_lullaby_to(favorite_plant)  # This should help them grow. Note that this\n    # comment is too long to fit on one line, given the recommended line length.\n    favorite_plant.water(100 * mL)  # Prevent dehydration.\n```\n([👆 back to top of ReadMe](#coblack)).\n\n\n\u003cbr\u003e\n\n#### Other comment styles\n\nOn own line, before code:\n```python\ndef care_for(self, favorite_plant):\n    \n    # This should help them grow. Note that this comment is too long to fit on one line,\n    # given the recommended line length.\n    self.sing_a_lullaby_to(favorite_plant)\n\n    # Prevent dehydration.\n    favorite_plant.water(100 * mL)\n```\n\nOn own line, after code:\n```python\ndef care_for(self, favorite_plant):\n    \n    self.sing_a_lullaby_to(favorite_plant)\n    # This should help them grow. Note that this comment is too long to fit on one line,\n    # given the recommended line length.\n    \n    favorite_plant.water(100 * mL)\n    # Prevent dehydration.\n```\n\nThese styles don't need _Coblack_;\na vanilla rewrapper like any of the following will do:\n- The [Wrap to Column](https://plugins.jetbrains.com/plugin/7234-wrap-to-column) plugin for PyCharm;\n- The [Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap) extension for VS Code;\n- The \"Wrap Paragraph at Ruler\" command in Sublime Text (`Alt-Q` or `Alt-⌘-Q`) ;\n- The `fill-paragraph` command in Emacs; or\n- The `gq` operator in Vim.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfiers%2Fcoblack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftfiers%2Fcoblack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfiers%2Fcoblack/lists"}