# Pre commit hooks
[pre-commit](https://pre-commit.com/) hook used to...
Check if the copyright is up to date (using the Git history).
## Adding to your `.pre-commit-config.yaml`
```yaml
ci:
skip:
# Skip the copyright check on pre-commit.ci because we don't have the Git history
- copyright
- copyright-required
# Poetry didn't works with Python 3.11
- poetry-lock
- poetry-check
repos:
- repo: https://github.com/sbrunner/hooks
rev: <version> # Use the ref you want to point at
hooks:
# Check that the copyright is up to date
- id: copyright
# Check that the copyright is present and up to date
- id: copyright-required
# Require a timeout in GitHub workflow files
- id: workflows-require-timeout
# Check Poetry config
- id: poetry-check
additional_dependencies:
- poetry==<version>
# Do Poetry lock
- id: poetry-lock
additional_dependencies:
- poetry==<version>
# Do Pipfile lock
- id: pipenv-lock
additional_dependencies:
- pipenv==<version>
# Do Helm lock (helm should be installed)
- id: helm-lock
- id: npm-lock
```
## Copyright configuration
The default values used in the `.github/copyright.yaml` file.
Default values:
```yaml
one_date_re: ' Copyright \\(c\\) (?P<year>[0-9]{4})"))'
two_date_re: ' Copyright \\(c\\) (?P<from>[0-9]{4})-(?P<to>[0-9]{4})")'
one_date_format: ' Copyright (c) {year}")'
two_date_format: ' Copyright (c) {from}-{to}")'
license_file: LICENSE
one_date_re: ' Copyright \(c\) (?P<year>[0-9]{4})'
two_date_re: ' Copyright \(c\) (?P<from>[0-9]{4})-(?P<to>[0-9]{4})'
one_date_format: ' Copyright (c) {year}'
two_date_format: ' Copyright (c) {from}-{to}'
license_file: LICENSE
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sbrunner/hooks",
"name": "sbrunner-hooks",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pre-commit",
"author": "St\u00e9phane Brunner",
"author_email": "stephane.brunner@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ff/ea/ab7861a2b2a538795550b84dc049e0a43e487625eee3386981053ce48bc8/sbrunner_hooks-1.1.2.tar.gz",
"platform": null,
"description": "# Pre commit hooks\n\n[pre-commit](https://pre-commit.com/) hook used to...\n\nCheck if the copyright is up to date (using the Git history).\n\n## Adding to your `.pre-commit-config.yaml`\n\n```yaml\nci:\n skip:\n # Skip the copyright check on pre-commit.ci because we don't have the Git history\n - copyright\n - copyright-required\n # Poetry didn't works with Python 3.11\n - poetry-lock\n - poetry-check\n\nrepos:\n - repo: https://github.com/sbrunner/hooks\n rev: <version> # Use the ref you want to point at\n hooks:\n # Check that the copyright is up to date\n - id: copyright\n # Check that the copyright is present and up to date\n - id: copyright-required\n # Require a timeout in GitHub workflow files\n - id: workflows-require-timeout\n # Check Poetry config\n - id: poetry-check\n additional_dependencies:\n - poetry==<version>\n # Do Poetry lock\n - id: poetry-lock\n additional_dependencies:\n - poetry==<version>\n # Do Pipfile lock\n - id: pipenv-lock\n additional_dependencies:\n - pipenv==<version>\n # Do Helm lock (helm should be installed)\n - id: helm-lock\n - id: npm-lock\n```\n\n## Copyright configuration\n\nThe default values used in the `.github/copyright.yaml` file.\n\nDefault values:\n\n```yaml\none_date_re: ' Copyright \\\\(c\\\\) (?P<year>[0-9]{4})\"))'\ntwo_date_re: ' Copyright \\\\(c\\\\) (?P<from>[0-9]{4})-(?P<to>[0-9]{4})\")'\none_date_format: ' Copyright (c) {year}\")'\ntwo_date_format: ' Copyright (c) {from}-{to}\")'\nlicense_file: LICENSE\n\none_date_re: ' Copyright \\(c\\) (?P<year>[0-9]{4})'\ntwo_date_re: ' Copyright \\(c\\) (?P<from>[0-9]{4})-(?P<to>[0-9]{4})'\none_date_format: ' Copyright (c) {year}'\ntwo_date_format: ' Copyright (c) {from}-{to}'\nlicense_file: LICENSE\n```\n\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Pre commit hook by sbrunner",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/sbrunner/hooks",
"Repository": "https://github.com/sbrunner/hooks"
},
"split_keywords": [
"pre-commit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdd4561603fa76baa0025f40ecad3bc546667d23698360d02be7e307e37d9bac",
"md5": "24cc0bcee00e1b83c03143733fcb8ea0",
"sha256": "b5d7deeb15b27d02ba7a984c63e0cef7efc5943b65f27b7492534857f1473cc5"
},
"downloads": -1,
"filename": "sbrunner_hooks-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24cc0bcee00e1b83c03143733fcb8ea0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6490,
"upload_time": "2024-10-10T12:43:57",
"upload_time_iso_8601": "2024-10-10T12:43:57.184493Z",
"url": "https://files.pythonhosted.org/packages/bd/d4/561603fa76baa0025f40ecad3bc546667d23698360d02be7e307e37d9bac/sbrunner_hooks-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ffeaab7861a2b2a538795550b84dc049e0a43e487625eee3386981053ce48bc8",
"md5": "8e3e5184a8559fb37986ab97782e4d15",
"sha256": "3b6c5196279aea76bc6fa73a54627d8c7cc2f83b967da4a58037f3126fa9de74"
},
"downloads": -1,
"filename": "sbrunner_hooks-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "8e3e5184a8559fb37986ab97782e4d15",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5189,
"upload_time": "2024-10-10T12:43:58",
"upload_time_iso_8601": "2024-10-10T12:43:58.661652Z",
"url": "https://files.pythonhosted.org/packages/ff/ea/ab7861a2b2a538795550b84dc049e0a43e487625eee3386981053ce48bc8/sbrunner_hooks-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 12:43:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sbrunner",
"github_project": "hooks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sbrunner-hooks"
}
JSON
