# ComForm: Python Comment Conformity Formatter
[](https://github.com/ambv/black)
[](https://pycqa.github.io/isort/)
An auto-formatter for pretty and readable comment formatting in python.
WARNING: `comform` is made for my own usage; it has minimal testing, compatibility, and
consideration of edge cases. Use it on your own code at peril `;)`.
Block comments (the only type formatted by default) are formatted as if they were
markdown text using the fantastic
[`mdformat`](https://github.com/executablebooks/mdformat) package. Treating comments as
markdown has drawbacks, but I've found these to be overwhelmingly outweighed.
## Usage
This package can be installed from PyPI as usual via `pip install comform` and is meant
to be used as a command line tool. It can also be used as a `pre-commit` hook, but only
with a local copy installed (known issue, see
[here](https://github.com/j-hil/comform/issues/2)). However `comform` is used I
recommend running `black` first; it was developed for this use-case.
The interface is:
```ps1
comform [-h] [--version] [--check] [--align] [--dividers] [--wrap N] paths [paths ...]
```
## Development
Too see my development process see [development.md](./docs/development.md).
Raw data
{
"_id": null,
"home_page": "",
"name": "comform",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "automation,comments,formatter",
"author": "",
"author_email": "j-hil <92876062+j-hil@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/1d/6d/a42195a832b3ace93222e1c91c1d3216bf016658a36a56048c78242c8247/comform-0.0.3.tar.gz",
"platform": null,
"description": "# ComForm: Python Comment Conformity Formatter\n\n[](https://github.com/ambv/black)\n[](https://pycqa.github.io/isort/)\n\nAn auto-formatter for pretty and readable comment formatting in python.\n\nWARNING: `comform` is made for my own usage; it has minimal testing, compatibility, and\nconsideration of edge cases. Use it on your own code at peril `;)`.\n\nBlock comments (the only type formatted by default) are formatted as if they were\nmarkdown text using the fantastic\n[`mdformat`](https://github.com/executablebooks/mdformat) package. Treating comments as\nmarkdown has drawbacks, but I've found these to be overwhelmingly outweighed.\n\n## Usage\n\nThis package can be installed from PyPI as usual via `pip install comform` and is meant\nto be used as a command line tool. It can also be used as a `pre-commit` hook, but only\nwith a local copy installed (known issue, see\n[here](https://github.com/j-hil/comform/issues/2)). However `comform` is used I\nrecommend running `black` first; it was developed for this use-case.\n\nThe interface is:\n\n```ps1\ncomform [-h] [--version] [--check] [--align] [--dividers] [--wrap N] paths [paths ...]\n```\n\n## Development\n\nToo see my development process see [development.md](./docs/development.md).\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Python Comment Conformity Formatter",
"version": "0.0.3",
"split_keywords": [
"automation",
"comments",
"formatter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bafdacbaf6475b0018468b366f53b3d21fe13ee617488049836def73ffd7ec11",
"md5": "810fe96c31479c4ab884868a3af4c7f8",
"sha256": "739ee9d5daa441ff04d730f2beb609dd031142e80750a08fdf94aea60fa8b2a6"
},
"downloads": -1,
"filename": "comform-0.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "810fe96c31479c4ab884868a3af4c7f8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 19343,
"upload_time": "2023-02-06T01:07:05",
"upload_time_iso_8601": "2023-02-06T01:07:05.320436Z",
"url": "https://files.pythonhosted.org/packages/ba/fd/acbaf6475b0018468b366f53b3d21fe13ee617488049836def73ffd7ec11/comform-0.0.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d6da42195a832b3ace93222e1c91c1d3216bf016658a36a56048c78242c8247",
"md5": "ed1d9a4b9914103b73fbe2e05d2f509f",
"sha256": "9c61ed839567aac338f1927a7f75b13e98f915b1ec5a4865234db7fd7abd96a8"
},
"downloads": -1,
"filename": "comform-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "ed1d9a4b9914103b73fbe2e05d2f509f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25014,
"upload_time": "2023-02-06T01:07:09",
"upload_time_iso_8601": "2023-02-06T01:07:09.488432Z",
"url": "https://files.pythonhosted.org/packages/1d/6d/a42195a832b3ace93222e1c91c1d3216bf016658a36a56048c78242c8247/comform-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 01:07:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "comform"
}
JSON