[](https://github.com/pre-commit-ci/pre-commit-ci-config/actions/workflows/main.yml)
[](https://results.pre-commit.ci/latest/github/pre-commit-ci/pre-commit-ci-config/main)
pre-commit-ci-config
====================
validation for [pre-commit.ci](https://pre-commit.ci) configuration
## installation
```bash
pip install pre-commit-ci-config
```
## api
### `pre_commit_ci_config.SCHEMA`
a [cfgv](https://github.com/asottile/cfgv) schema.
the expected input to this schema is the loaded top-level pre-commit
configuration.
```pycon
>>> import cfgv
>>> from pre_commit.clientlib import load_config
>>> from pre_commit_ci_config import SCHEMA
>>> cfg = load_config('.pre-commit-config.yaml')
>>> cfg = cfgv.validate(cfg, SCHEMA)
>>> cfg = cfgv.apply_defaults(cfg, SCHEMA)
```
### `check-pre-commit-ci-config`
a commandline tool to validate the configuration
```console
$ check-pre-commit-ci-config .pre-commit-config.yaml
$
```
## as a pre-commit hook
See [pre-commit](https://github.com/pre-commit/pre-commit) for instructions
Sample `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/pre-commit-ci/pre-commit-ci-config
rev: v1.6.1
hooks:
- id: check-pre-commit-ci-config
```
Raw data
{
"_id": null,
"home_page": "https://github.com/pre-commit-ci/pre-commit-ci-config",
"name": "pre-commit-ci-config",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Anthony Sottile",
"author_email": "asottile@umich.edu",
"download_url": "https://files.pythonhosted.org/packages/90/ba/0e9394c1262194819a5a1494dcf3098a7339965f4b1f619bf1bea7975450/pre_commit_ci_config-1.6.1.tar.gz",
"platform": null,
"description": "[](https://github.com/pre-commit-ci/pre-commit-ci-config/actions/workflows/main.yml)\n[](https://results.pre-commit.ci/latest/github/pre-commit-ci/pre-commit-ci-config/main)\n\npre-commit-ci-config\n====================\n\nvalidation for [pre-commit.ci](https://pre-commit.ci) configuration\n\n## installation\n\n```bash\npip install pre-commit-ci-config\n```\n\n## api\n\n### `pre_commit_ci_config.SCHEMA`\n\na [cfgv](https://github.com/asottile/cfgv) schema.\n\nthe expected input to this schema is the loaded top-level pre-commit\nconfiguration.\n\n```pycon\n>>> import cfgv\n>>> from pre_commit.clientlib import load_config\n>>> from pre_commit_ci_config import SCHEMA\n>>> cfg = load_config('.pre-commit-config.yaml')\n>>> cfg = cfgv.validate(cfg, SCHEMA)\n>>> cfg = cfgv.apply_defaults(cfg, SCHEMA)\n```\n\n### `check-pre-commit-ci-config`\n\na commandline tool to validate the configuration\n\n```console\n$ check-pre-commit-ci-config .pre-commit-config.yaml\n$\n```\n\n## as a pre-commit hook\n\nSee [pre-commit](https://github.com/pre-commit/pre-commit) for instructions\n\nSample `.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/pre-commit-ci/pre-commit-ci-config\n rev: v1.6.1\n hooks:\n - id: check-pre-commit-ci-config\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "validation for pre-commit.ci configuration",
"version": "1.6.1",
"project_urls": {
"Homepage": "https://github.com/pre-commit-ci/pre-commit-ci-config"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a72fb4f507aa9c7c9e461a5633822d4b7d439779884c74d24f0e10c70ef5d4de",
"md5": "e871984d1fd9661113fd39074e15d14a",
"sha256": "b0f33e5cfa1a7f4d4a379f308a3a18103511fc616c8eef8ef025413ce5554888"
},
"downloads": -1,
"filename": "pre_commit_ci_config-1.6.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e871984d1fd9661113fd39074e15d14a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 4290,
"upload_time": "2023-09-11T23:01:03",
"upload_time_iso_8601": "2023-09-11T23:01:03.610281Z",
"url": "https://files.pythonhosted.org/packages/a7/2f/b4f507aa9c7c9e461a5633822d4b7d439779884c74d24f0e10c70ef5d4de/pre_commit_ci_config-1.6.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90ba0e9394c1262194819a5a1494dcf3098a7339965f4b1f619bf1bea7975450",
"md5": "5e8119f2d03196a04e4991be49487302",
"sha256": "ed65ff72907a1a0664387d7651a4d11a8ca8ed4316900e695d317f3060ff6680"
},
"downloads": -1,
"filename": "pre_commit_ci_config-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "5e8119f2d03196a04e4991be49487302",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3784,
"upload_time": "2023-09-11T23:01:05",
"upload_time_iso_8601": "2023-09-11T23:01:05.064110Z",
"url": "https://files.pythonhosted.org/packages/90/ba/0e9394c1262194819a5a1494dcf3098a7339965f4b1f619bf1bea7975450/pre_commit_ci_config-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-11 23:01:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pre-commit-ci",
"github_project": "pre-commit-ci-config",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pre-commit-ci-config"
}
JSON
