pyscaffoldext-pre-commit-ruff
=============================
`PyScaffold`_ extension to use the `Ruff Linter`_ and `Ruff Formatter`_
in place of the `Pre Commit Extension`_, ``putup --pre-commit`` defaults
`flake8`_ and `isort`_.
The ``ruff`` configuration is added to ``pyproject.toml`` because
``ruff`` does not support ``setup.cfg``. Some `Ruff Linter`_ recommended
settings are commented out, for consistency with `PyScaffold`_'s
``flake8`` settings.
`Codespell`_ is added to `pre-commit`_ configuration in
``.pre-commit-config.yaml``; uncomment to enable.
`Mypy`_ settings are added to ``setup.cfg``.
Usage
-----
Just install this package with
``pip install pyscaffoldext-pre-commit-ruff`` and note that ``putup -h``
shows a new option ``--pre-commit-ruff``. Use this flag to use the `Ruff
Linter`_ and `Ruff Formatter`_ in place of ``putup --pre-commit``
defaults `flake8`_ and `isort`_.
.. _pyscaffold-notes:
Making Changes & Contributing
-----------------------------
This project uses `pre-commit`_, please make sure to install it before
making any changes:
::
uv tool install pre-commit
cd pyscaffoldext-pre-commit-ruff
pre-commit install
It is a good idea to update the hooks to the latest version:
::
pre-commit autoupdate
Note
----
This project has been set up using PyScaffold 4.6. For details and usage
information on PyScaffold see https://pyscaffold.org/.
.. _PyScaffold: https://pyscaffold.org/
.. _Ruff Linter: https://docs.astral.sh/ruff/linter/
.. _Ruff Formatter: https://docs.astral.sh/ruff/formatter/
.. _Pre Commit Extension: https://pyscaffold.org/en/stable/features.html#pre-commit-hooks
.. _flake8: https://flake8.pycqa.org/
.. _isort: https://pycqa.github.io/isort/
.. _Codespell: https://github.com/codespell-project/codespell
.. _pre-commit: https://pre-commit.com/
.. _Mypy: https://mypy.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/pyscaffold/pyscaffold/",
"name": "pyscaffoldext-pre-commit-ruff",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "John D. Fisher",
"author_email": "jdfenw@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ef/f7/7739c7553ab54bfc37ac73e5f2c405b69ea36751bc1f4d63444c285a158a/pyscaffoldext_pre_commit_ruff-1.0.0.tar.gz",
"platform": "any",
"description": "pyscaffoldext-pre-commit-ruff\n=============================\n\n`PyScaffold`_ extension to use the `Ruff Linter`_ and `Ruff Formatter`_\nin place of the `Pre Commit Extension`_, ``putup --pre-commit`` defaults\n`flake8`_ and `isort`_.\n\nThe ``ruff`` configuration is added to ``pyproject.toml`` because\n``ruff`` does not support ``setup.cfg``. Some `Ruff Linter`_ recommended\nsettings are commented out, for consistency with `PyScaffold`_'s\n``flake8`` settings.\n\n`Codespell`_ is added to `pre-commit`_ configuration in\n``.pre-commit-config.yaml``; uncomment to enable.\n\n`Mypy`_ settings are added to ``setup.cfg``.\n\nUsage\n-----\n\nJust install this package with\n``pip install pyscaffoldext-pre-commit-ruff`` and note that ``putup -h``\nshows a new option ``--pre-commit-ruff``. Use this flag to use the `Ruff\nLinter`_ and `Ruff Formatter`_ in place of ``putup --pre-commit``\ndefaults `flake8`_ and `isort`_.\n\n.. _pyscaffold-notes:\n\nMaking Changes & Contributing\n-----------------------------\n\nThis project uses `pre-commit`_, please make sure to install it before\nmaking any changes:\n\n::\n\n uv tool install pre-commit\n cd pyscaffoldext-pre-commit-ruff\n pre-commit install\n\nIt is a good idea to update the hooks to the latest version:\n\n::\n\n pre-commit autoupdate\n\nNote\n----\n\nThis project has been set up using PyScaffold 4.6. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n\n.. _PyScaffold: https://pyscaffold.org/\n.. _Ruff Linter: https://docs.astral.sh/ruff/linter/\n.. _Ruff Formatter: https://docs.astral.sh/ruff/formatter/\n.. _Pre Commit Extension: https://pyscaffold.org/en/stable/features.html#pre-commit-hooks\n.. _flake8: https://flake8.pycqa.org/\n.. _isort: https://pycqa.github.io/isort/\n.. _Codespell: https://github.com/codespell-project/codespell\n.. _pre-commit: https://pre-commit.com/\n.. _Mypy: https://mypy.readthedocs.io/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add a short description here!",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://pyscaffold.org/",
"Homepage": "https://github.com/pyscaffold/pyscaffold/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa47892f4b54ecb272321af0231de6d9e5b6804473c5f111d21ea960fb1f6843",
"md5": "1512ef05d9e989fea1b34ae22ce08366",
"sha256": "84a6eb5695e5a7fa8a6636f6664c3b3ab3bf6270e6c78dc359b17a7d4262ab58"
},
"downloads": -1,
"filename": "pyscaffoldext_pre_commit_ruff-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1512ef05d9e989fea1b34ae22ce08366",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7475,
"upload_time": "2024-11-21T23:49:38",
"upload_time_iso_8601": "2024-11-21T23:49:38.489446Z",
"url": "https://files.pythonhosted.org/packages/aa/47/892f4b54ecb272321af0231de6d9e5b6804473c5f111d21ea960fb1f6843/pyscaffoldext_pre_commit_ruff-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eff77739c7553ab54bfc37ac73e5f2c405b69ea36751bc1f4d63444c285a158a",
"md5": "15e868e2bd034207bf01c681ef78c219",
"sha256": "cf7d2cdb95c98ff2763c73d48362df34c5074f83f97b65bd8be881006da15017"
},
"downloads": -1,
"filename": "pyscaffoldext_pre_commit_ruff-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "15e868e2bd034207bf01c681ef78c219",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27350,
"upload_time": "2024-11-21T23:49:40",
"upload_time_iso_8601": "2024-11-21T23:49:40.175097Z",
"url": "https://files.pythonhosted.org/packages/ef/f7/7739c7553ab54bfc37ac73e5f2c405b69ea36751bc1f4d63444c285a158a/pyscaffoldext_pre_commit_ruff-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 23:49:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyscaffold",
"github_project": "pyscaffold",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "pyscaffoldext-pre-commit-ruff"
}
JSON
