# editorconfig-checker.python
<p align="center">
<a href="https://pypi.org/project/editorconfig-checker/"><img src="https://img.shields.io/pypi/v/editorconfig-checker.svg?style=flat&logo=pypi" alt="PyPI Latest Release"></a>
<a href="https://pepy.tech/project/editorconfig-checker"><img src="https://pepy.tech/badge/editorconfig-checker" alt="Downloads"> </a>
<a href="http://choosealicense.com/licenses/mit/"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="MIT License"></a>
</p>
A Python wrapper to provide a pip-installable [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) binary.
Internally, this package provides a convenient way to download the pre-built `editorconfig-checker` binary for your particular platform.
## Installation
- From source code:
```
pip install .
```
- From `PyPI`:
```
pip install editorconfig-checker
```
## Usage
After installation, the `ec` binary should be available in your environment (or `ec.exe` on Windows):
```
ec -version
```
## Usage with the pre-commit git hooks framework
`editorconfig-checker` can be included as a hook for [pre-commit](https://pre-commit.com/).
The easiest way to get started is to add this configuration to your `.pre-commit-config.yaml`:
```yaml
repos:
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
rev: '' # pick a git hash / tag to point to
hooks:
- id: editorconfig-checker
alias: ec
```
The above hook is a python wrapper that automatically downloads and installs
[editorconfig-checker](https://editorconfig-checker.github.io/) binary.
If you manage your tools in some other way, for example, via [ASDF](https://asdf-vm.com/),
you may want to use an alternative pre-commit hook that assumes that
`ec` binary executable is already available on the system path:
```yaml
repos:
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
rev: '' # pick a git hash / tag to point to
hooks:
- id: editorconfig-checker-system
alias: ec
```
See the [pre-commit docs](https://pre-commit.com/#pre-commit-configyaml---hooks) to check how to customize this configuration.
Raw data
{
"_id": null,
"home_page": "https://github.com/editorconfig-checker/editorconfig-checker.python",
"name": "editorconfig-checker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": null,
"author": "Marco M.",
"author_email": "mmicu.github00@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/cf/49/2ad11cac89672199f8eadba362234e5b03e1659ae9d9d7a1b3f4b40e2533/editorconfig-checker-3.0.3.tar.gz",
"platform": null,
"description": "# editorconfig-checker.python\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/editorconfig-checker/\"><img src=\"https://img.shields.io/pypi/v/editorconfig-checker.svg?style=flat&logo=pypi\" alt=\"PyPI Latest Release\"></a>\n <a href=\"https://pepy.tech/project/editorconfig-checker\"><img src=\"https://pepy.tech/badge/editorconfig-checker\" alt=\"Downloads\"> </a>\n <a href=\"http://choosealicense.com/licenses/mit/\"><img src=\"https://img.shields.io/badge/license-MIT-blue.svg?style=flat\" alt=\"MIT License\"></a>\n</p>\n\nA Python wrapper to provide a pip-installable [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) binary.\n\nInternally, this package provides a convenient way to download the pre-built `editorconfig-checker` binary for your particular platform.\n\n## Installation\n\n- From source code:\n ```\n pip install .\n ```\n- From `PyPI`:\n ```\n pip install editorconfig-checker\n ```\n\n## Usage\n\nAfter installation, the `ec` binary should be available in your environment (or `ec.exe` on Windows):\n\n```\nec -version\n```\n\n## Usage with the pre-commit git hooks framework\n\n`editorconfig-checker` can be included as a hook for [pre-commit](https://pre-commit.com/).\nThe easiest way to get started is to add this configuration to your `.pre-commit-config.yaml`:\n\n```yaml\nrepos:\n- repo: https://github.com/editorconfig-checker/editorconfig-checker.python\n rev: '' # pick a git hash / tag to point to\n hooks:\n - id: editorconfig-checker\n alias: ec\n```\n\nThe above hook is a python wrapper that automatically downloads and installs\n[editorconfig-checker](https://editorconfig-checker.github.io/) binary.\nIf you manage your tools in some other way, for example, via [ASDF](https://asdf-vm.com/),\nyou may want to use an alternative pre-commit hook that assumes that\n`ec` binary executable is already available on the system path:\n\n```yaml\nrepos:\n- repo: https://github.com/editorconfig-checker/editorconfig-checker.python\n rev: '' # pick a git hash / tag to point to\n hooks:\n - id: editorconfig-checker-system\n alias: ec\n```\n\nSee the [pre-commit docs](https://pre-commit.com/#pre-commit-configyaml---hooks) to check how to customize this configuration.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper around invoking editorconfig-checker (https://github.com/editorconfig-checker/editorconfig-checker)",
"version": "3.0.3",
"project_urls": {
"Homepage": "https://github.com/editorconfig-checker/editorconfig-checker.python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf492ad11cac89672199f8eadba362234e5b03e1659ae9d9d7a1b3f4b40e2533",
"md5": "a14d99d9cfd0dd69f5528fc6d0e4533e",
"sha256": "1771336e94b9e0c7791126206e5127edd0add664e2040daacf0b5b685a3fa242"
},
"downloads": -1,
"filename": "editorconfig-checker-3.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a14d99d9cfd0dd69f5528fc6d0e4533e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 4814,
"upload_time": "2024-08-25T18:15:14",
"upload_time_iso_8601": "2024-08-25T18:15:14.309433Z",
"url": "https://files.pythonhosted.org/packages/cf/49/2ad11cac89672199f8eadba362234e5b03e1659ae9d9d7a1b3f4b40e2533/editorconfig-checker-3.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 18:15:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "editorconfig-checker",
"github_project": "editorconfig-checker.python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "editorconfig-checker"
}
JSON
