# forge-format
A unified, opinionated code formatting command for Django projects.
Uses [black](https://github.com/psf/black) and [ruff](https://github.com/charliermarsh/ruff/) to format Python code.
## Installation
First, install `forge-format` from [PyPI](https://pypi.org/project/forge-format/):
```sh
pip install forge-format
```
Now you will have access to the `format` command:
```sh
forge format
```
Note that if you're using black + ruff for the first time,
a common issue is to get a bunch of `E501 Line too long` errors on code comments.
This is because black doesn't fix line lengths on comments!
If there are more than you want to fix, just add this to your `pyproject.toml`:
```toml
[tool.ruff]
# Never enforce `E501` (line length violations).
ignore = ["E501"]
```
Raw data
{
"_id": null,
"home_page": "https://www.forgepackages.com/",
"name": "forge-format",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "django,saas,forge,framework",
"author": "Dave Gaeddert",
"author_email": "dave.gaeddert@dropseed.dev",
"download_url": "https://files.pythonhosted.org/packages/e1/cf/110e7f689d4b167225678615c74606d187c8bdc2344b33b3a87bdeb9db5e/forge_format-1.1.0.tar.gz",
"platform": null,
"description": "# forge-format\n\nA unified, opinionated code formatting command for Django projects.\n\nUses [black](https://github.com/psf/black) and [ruff](https://github.com/charliermarsh/ruff/) to format Python code.\n\n\n## Installation\n\nFirst, install `forge-format` from [PyPI](https://pypi.org/project/forge-format/):\n\n```sh\npip install forge-format\n```\n\nNow you will have access to the `format` command:\n\n```sh\nforge format\n```\n\nNote that if you're using black + ruff for the first time,\na common issue is to get a bunch of `E501 Line too long` errors on code comments.\nThis is because black doesn't fix line lengths on comments!\nIf there are more than you want to fix, just add this to your `pyproject.toml`:\n\n```toml\n[tool.ruff]\n# Never enforce `E501` (line length violations).\nignore = [\"E501\"]\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Formatting library for Forge",
"version": "1.1.0",
"split_keywords": [
"django",
"saas",
"forge",
"framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2fd6293ba702fa3e51d1585ad5e2a2e56afcaa3228e4539ad606d6c816e6d22",
"md5": "d177ad2879643c83418744246ebac5b1",
"sha256": "113838d766ce046142e66baee5bd2fc24701d26476ee0203e54836f9c08bb64d"
},
"downloads": -1,
"filename": "forge_format-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d177ad2879643c83418744246ebac5b1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3582,
"upload_time": "2023-03-27T20:43:58",
"upload_time_iso_8601": "2023-03-27T20:43:58.393142Z",
"url": "https://files.pythonhosted.org/packages/d2/fd/6293ba702fa3e51d1585ad5e2a2e56afcaa3228e4539ad606d6c816e6d22/forge_format-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1cf110e7f689d4b167225678615c74606d187c8bdc2344b33b3a87bdeb9db5e",
"md5": "edb2885991ee85c470c6beefab1e94ba",
"sha256": "9b52f9790a80b7c2189fe0878f1fa3859a8aa973e1b7be6328b82d04fefc6fba"
},
"downloads": -1,
"filename": "forge_format-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "edb2885991ee85c470c6beefab1e94ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 2780,
"upload_time": "2023-03-27T20:44:00",
"upload_time_iso_8601": "2023-03-27T20:44:00.580424Z",
"url": "https://files.pythonhosted.org/packages/e1/cf/110e7f689d4b167225678615c74606d187c8bdc2344b33b3a87bdeb9db5e/forge_format-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-27 20:44:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "forge-format"
}
JSON