# Prospector profile utils
It contains some utility Prospector profiles.
## Usage
```bash
pip install prospector-profile-utils
```
Then, in your `.prospector.yaml` file, you can use the profiles like this:
```yaml
inherits:
- utils:base
- utils:c2cwsgiutils
- utils:no-design-checks
```
It provide also an alternate base witch activate less strict checks:
```yaml
inherits:
- utils:base-less-strict
```
Additional available profiles:
- `utils:fix`: Disables specific rules that are known to have reliability issues.
- `utils:autofix`: Enables automatic fixing capabilities for supported rules.
- `utils:tests`: Specifically designed for test files validation, recommended to use in combination with the `utils:fix` or `utils:pre-commit` profiles.
- `utils:pre-commit`: Specifically designed for pre-commit hooks.
## pre-commit profile
I use the `utils:tests` and `utils:pre-commit` profiles with the following precommit configuration to have the ruff checks with auto-fix on all the files with a specific profile for the tests.
```yaml
repos:
- repo: https://github.com/PyCQA/prospector
rev: v<rev>
hooks:
- id: prospector
args:
- --die-on-tool-error
- --output-format=pylint
- --profile=utils:pre-commit
- --profile=.prospector.yaml
additional_dependencies:
- prospector-profile-duplicated==<rev> # pypi
- prospector-profile-utils==<rev> # pypi
- id: prospector
args:
- --die-on-tool-error
- --output-format=pylint
- --profile=utils:pre-commit
- --profile=utils:tests
additional_dependencies:
- prospector-profile-utils==<rev> # pypi
```
## Contributing
Install the pre-commit hooks:
```bash
pip install pre-commit
pre-commit install --allow-missing-config
```
Raw data
{
"_id": null,
"home_page": null,
"name": "prospector-profile-utils",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "St\u00e9phane Brunner",
"author_email": "stephane.brunner@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/32/9c/1c7680366544e2f1a3cb1fc866a02018a9c18010914767e6c555a6f368d6/prospector_profile_utils-1.21.9.tar.gz",
"platform": null,
"description": "# Prospector profile utils\n\nIt contains some utility Prospector profiles.\n\n## Usage\n\n```bash\npip install prospector-profile-utils\n```\n\nThen, in your `.prospector.yaml` file, you can use the profiles like this:\n\n```yaml\ninherits:\n - utils:base\n - utils:c2cwsgiutils\n - utils:no-design-checks\n```\n\nIt provide also an alternate base witch activate less strict checks:\n\n```yaml\ninherits:\n - utils:base-less-strict\n```\n\nAdditional available profiles:\n\n- `utils:fix`: Disables specific rules that are known to have reliability issues.\n- `utils:autofix`: Enables automatic fixing capabilities for supported rules.\n- `utils:tests`: Specifically designed for test files validation, recommended to use in combination with the `utils:fix` or `utils:pre-commit` profiles.\n- `utils:pre-commit`: Specifically designed for pre-commit hooks.\n\n## pre-commit profile\n\nI use the `utils:tests` and `utils:pre-commit` profiles with the following precommit configuration to have the ruff checks with auto-fix on all the files with a specific profile for the tests.\n\n```yaml\nrepos:\n - repo: https://github.com/PyCQA/prospector\n rev: v<rev>\n hooks:\n - id: prospector\n args:\n - --die-on-tool-error\n - --output-format=pylint\n - --profile=utils:pre-commit\n - --profile=.prospector.yaml\n additional_dependencies:\n - prospector-profile-duplicated==<rev> # pypi\n - prospector-profile-utils==<rev> # pypi\n - id: prospector\n args:\n - --die-on-tool-error\n - --output-format=pylint\n - --profile=utils:pre-commit\n - --profile=utils:tests\n additional_dependencies:\n - prospector-profile-utils==<rev> # pypi\n```\n\n## Contributing\n\nInstall the pre-commit hooks:\n\n```bash\npip install pre-commit\npre-commit install --allow-missing-config\n```\n\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Some utility Prospector profiles.",
"version": "1.21.9",
"project_urls": {
"Homepage": "https://github.com/sbrunner/prospector-profile-utils",
"Repository": "https://github.com/sbrunner/prospector-profile-utils"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b553f0246c51ebcb7b809c470b380ce77faf5fe3cecad7994f5595569c70b9f8",
"md5": "b39e897fa0eeb568655b0e9c289d9ec9",
"sha256": "bbd8b91d0b7ccc2bda3e2f6b6188303ea3415193382d8ce79052a2a8a2a2a9c2"
},
"downloads": -1,
"filename": "prospector_profile_utils-1.21.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b39e897fa0eeb568655b0e9c289d9ec9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7835,
"upload_time": "2025-03-02T14:09:30",
"upload_time_iso_8601": "2025-03-02T14:09:30.709527Z",
"url": "https://files.pythonhosted.org/packages/b5/53/f0246c51ebcb7b809c470b380ce77faf5fe3cecad7994f5595569c70b9f8/prospector_profile_utils-1.21.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "329c1c7680366544e2f1a3cb1fc866a02018a9c18010914767e6c555a6f368d6",
"md5": "40c6e689d45b3c17a111b97d3dc26765",
"sha256": "08dd034d3022cacf4e911a36094b84d54314c1b4bf7c9f52932c41b0abe0ed1c"
},
"downloads": -1,
"filename": "prospector_profile_utils-1.21.9.tar.gz",
"has_sig": false,
"md5_digest": "40c6e689d45b3c17a111b97d3dc26765",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5090,
"upload_time": "2025-03-02T14:09:32",
"upload_time_iso_8601": "2025-03-02T14:09:32.375268Z",
"url": "https://files.pythonhosted.org/packages/32/9c/1c7680366544e2f1a3cb1fc866a02018a9c18010914767e6c555a6f368d6/prospector_profile_utils-1.21.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-02 14:09:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sbrunner",
"github_project": "prospector-profile-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "prospector-profile-utils"
}
JSON
