{"id":20793816,"url":"https://github.com/telekom/style-doc","last_synced_at":"2025-05-05T23:53:07.882Z","repository":{"id":47730781,"uuid":"382755885","full_name":"telekom/style-doc","owner":"telekom","description":"Black for Python docstrings and reStructuredText (rst).","archived":false,"fork":false,"pushed_at":"2023-04-07T09:35:32.000Z","size":145,"stargazers_count":18,"open_issues_count":8,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-01T02:45:13.925Z","etag":null,"topics":["automation","black","docstring","docstrings","formatter","formatting","linter","linting","python","restructured-text","restructuredtext","rst"],"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/telekom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-07-04T03:44:24.000Z","updated_at":"2024-12-30T12:57:02.000Z","dependencies_parsed_at":"2024-11-17T16:11:54.760Z","dependency_job_id":"9c30907e-b91e-4565-becb-398da3b92efc","html_url":"https://github.com/telekom/style-doc","commit_stats":{"total_commits":76,"total_committers":2,"mean_commits":38.0,"dds":0.07894736842105265,"last_synced_commit":"24a3796955465fb6d5de945571e686fdc4858eb3"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telekom%2Fstyle-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telekom%2Fstyle-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telekom%2Fstyle-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telekom%2Fstyle-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telekom","download_url":"https://codeload.github.com/telekom/style-doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252596391,"owners_count":21773844,"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","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":["automation","black","docstring","docstrings","formatter","formatting","linter","linting","python","restructured-text","restructuredtext","rst"],"created_at":"2024-11-17T16:11:45.405Z","updated_at":"2025-05-05T23:53:07.866Z","avatar_url":"https://github.com/telekom.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Style-Doc\n\n[![Apache 2.0 License](https://img.shields.io/github/license/telekom/style-doc)](https://github.com/telekom/style-doc/blob/main/LICENSE)\n[![Contributor Covenant](https://img.shields.io/badge/Code%20of%20Conduct-Contributor%20Covenant-ff69b4.svg)](https://github.com/telekom/style-doc/blob/main/CODE_OF_CONDUCT.md)\n[![Python Version](https://img.shields.io/pypi/pyversions/style-doc)](https://www.python.org)\n[![pypi](https://img.shields.io/pypi/v/style-doc.svg)](https://pypi.python.org/pypi/style-doc)\n\u003cbr/\u003e\n[![pytest](https://github.com/telekom/style-doc/actions/workflows/pytest.yml/badge.svg)](https://github.com/telekom/style-doc/actions/workflows/pytest.yml)\n[![Static Code Checks](https://github.com/telekom/style-doc/actions/workflows/static_checks.yml/badge.svg)](https://github.com/telekom/style-doc/actions/workflows/static_checks.yml)\n[![GitHub issues](https://img.shields.io/github/issues-raw/telekom/style-doc)](https://github.com/telekom/style-doc/issues)\n\nStyle-Doc is Black for Python docstrings and reStructuredText (rst). It can be used to format\ndocstrings ([Google docstring format](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings))\nin Python files or [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html).\n\nStyle-Doc can handle Linux, Windows and Mac style line endings. The output will nevertheless be convertet to `\\n` Linux line endings.\n\n## Table of Contents\n\n- [Maintainers](#maintainers)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Support and Feedback](#support-and-feedback)\n- [Reporting Security Vulnerabilities](#reporting-security-vulnerabilities)\n- [Contribution](#contribution)\n- [Code of Conduct](#code-of-conduct)\n- [Licensing](#licensing)\n\n## Maintainers\n\n![One Conversation](https://raw.githubusercontent.com/telekom/style-doc/main/docs/source/imgs/1c-logo.png)\n\u003cbr/\u003e\nThis project is maintained by the [One Conversation](https://www.welove.ai/)\nteam of [Deutsche Telekom AG](https://www.telekom.com/).\nIt is based on the\n[style_doc.py](https://github.com/huggingface/transformers/blob/23ab0b6980e8af5e0b42905d8c09d388245a029d/utils/style_doc.py)\nscript from the [HuggingFace](https://huggingface.co/) team.\nMany thanks for [your consent](https://github.com/huggingface/transformers/issues/12473)\nto publish it as a standalone package 🤗 ♥.\n\n## Installation\n\nStyle-Doc is available at [the Python Package Index (PyPI)](https://pypi.org/project/style-doc/).\nIt can be installed with pip:\n\n```bash\n$ pip install style-doc\n```\n\n## Usage\n\n```bash\n$ style-doc --help\nusage: style-doc [-h] [--max_len MAX_LEN] [--check_only] [--py_only]\n                 [--rst_only]\n                 files [files ...]\n\npositional arguments:\n  files              file(s) or folder(s) to restyle\n\noptional arguments:\n  -h, --help         show this help message and exit\n  --max_len MAX_LEN  maximum length of lines, default: 119\n  --check_only       only check and not fix styling issues\n  --py_only          only check py files\n  --rst_only         only check rst files\n```\n\n### Examples\n\n- format all docstrings (.py files) and rst files in the `src` and `docs` folder with line length of 99:\u003cbr/\u003e\n  `style-doc --max_len 99 src docs`\n- check all docstrings (.py files) and rst files in the `src` and `docs` folder with line length of 99:\u003cbr/\u003e\n  `style-doc --max_len 99 --check_only src docs`\n- format all docstrings (.py files only) in the `src` folder with line length of 99:\u003cbr/\u003e\n  `style-doc --max_len 99 --py_only src`\n- check all docstrings (.py files only) in the `src` folder with line length of 99:\u003cbr/\u003e\n  `style-doc --max_len 99 --check_only --py_only src`\n- format all rst files only in the `docs` folder with line length of 99:\u003cbr/\u003e\n  `style-doc --max_len 99 --rst_only docs`\n- check all rst files only in the `docs` folder with line length of 99:\u003cbr/\u003e\n  `style-doc --max_len 99 --check_only --rst_only docs`\n\nTo integrate Style-Doc (and more checks) into your [GitHub Actions](https://docs.github.com/en/actions) see our\n[static_checks.yml](https://github.com/telekom/style-doc/blob/main/.github/workflows/static_checks.yml)\nexample and our configuration in [setup.py](https://github.com/telekom/style-doc/blob/main/setup.py).\n\n## Support and Feedback\n\nThe following channels are available for discussions, feedback, and support requests:\n\n- [open an issue in our GitHub repository](https://github.com/telekom/style-doc/issues/new/choose)\n- [send an e-mail to our open source team](mailto:opensource@telekom.de)\n\n## Reporting Security Vulnerabilities\n\nThis project is built with security and data privacy in mind to ensure your data is safe.\nWe are grateful for security researchers and users reporting a vulnerability to us, first.\nTo ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities\ncan be assured, please follow the below guideline.\n\n**Please do not report security vulnerabilities directly on GitHub.\nGitHub Issues can be publicly seen and therefore would result in a direct disclosure.**\n\nPlease address questions about data privacy, security concepts,\nand other media requests to the [opensource@telekom.de](mailto:opensource@telekom.de) mailbox.\n\n## Contribution\n\nOur commitment to open source means that we are enabling - in fact encouraging - all interested\nparties to contribute and become part of our developer community.\n\nContribution and feedback is encouraged and always welcome. For more information about how to\ncontribute, as well as additional contribution information, see our\n[Contribution Guidelines](https://github.com/telekom/style-doc/blob/main/CONTRIBUTING.md).\n\n## Code of Conduct\n\nThis project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/)\nas our code of conduct. Please see the details in our\n[Contributor Covenant Code of Conduct](https://github.com/telekom/style-doc/blob/main/CODE_OF_CONDUCT.md).\nAll contributors must abide by the code of conduct.\n\n## Licensing\n\nCopyright (c) 2020 The HuggingFace Inc. team\u003cbr/\u003e\nCopyright (c) 2021 Philip May, Deutsche Telekom AG\n\nLicensed under the [Apache License, Version 2.0](https://github.com/telekom/style-doc/blob/main/LICENSE) (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelekom%2Fstyle-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelekom%2Fstyle-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelekom%2Fstyle-doc/lists"}