..
This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
Copyright 2022-2023 Kurt McKee <contactme@kurtmckee.org>
SPDX-License-Identifier: MIT
Chipshot
########
*Set up game-winning headers!*
----
Chipshot helps standardize header information in software development files.
Its target goal is to ensure that copyright dates are standardized
and that licensing information is present.
It supports a wide range of file formats,
including source code and documentation formats.
It purposely does not support configuration file formats by default
(such as TOML, INI, or YAML)
but can be configured to support those, too.
Sample configuration
====================
Create a file named ``.chipshot.toml`` with the following content:
.. code-block:: toml
[chipshot]
template = """
Copyright 2021-{{ year }} Developer or Company
Released under the terms of the MIT license.
SPDX-License-Identifier: MIT
"""
You can then run ``chipshot path1 path2`` to see what files will be modified.
If you're satisfied, run ``chipshot --update path1 path2`` to update the files.
Pre-commit hooks
================
Chipshot offers two pre-commit hooks to help you manage your projects:
* ``check-headers``
* ``update-headers``
Here's a sample configuration for ensuring your files have correct headers:
.. code-block:: yaml
# .pre-commit-config.yaml
repos:
- repo: 'https://github.com/kurtmckee/chipshot'
rev: 'v0.4.0'
hooks:
- id: 'update-headers'
Raw data
{
"_id": null,
"home_page": "https://github.com/kurtmckee/chipshot",
"name": "chipshot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Kurt McKee",
"author_email": "contactme@kurtmckee.org",
"download_url": "https://files.pythonhosted.org/packages/6e/bd/4c6ec514e2785700b7d2a857003c66302d6cbee100e860eac79911c2d66f/chipshot-0.7.0.tar.gz",
"platform": null,
"description": "..\n This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>\n Copyright 2022-2023 Kurt McKee <contactme@kurtmckee.org>\n SPDX-License-Identifier: MIT\n\n\nChipshot\n########\n\n*Set up game-winning headers!*\n\n----\n\nChipshot helps standardize header information in software development files.\n\nIts target goal is to ensure that copyright dates are standardized\nand that licensing information is present.\n\nIt supports a wide range of file formats,\nincluding source code and documentation formats.\nIt purposely does not support configuration file formats by default\n(such as TOML, INI, or YAML)\nbut can be configured to support those, too.\n\n\nSample configuration\n====================\n\nCreate a file named ``.chipshot.toml`` with the following content:\n\n.. code-block:: toml\n\n [chipshot]\n template = \"\"\"\n Copyright 2021-{{ year }} Developer or Company\n Released under the terms of the MIT license.\n SPDX-License-Identifier: MIT\n \"\"\"\n\nYou can then run ``chipshot path1 path2`` to see what files will be modified.\nIf you're satisfied, run ``chipshot --update path1 path2`` to update the files.\n\n\nPre-commit hooks\n================\n\nChipshot offers two pre-commit hooks to help you manage your projects:\n\n* ``check-headers``\n* ``update-headers``\n\nHere's a sample configuration for ensuring your files have correct headers:\n\n.. code-block:: yaml\n\n # .pre-commit-config.yaml\n repos:\n - repo: 'https://github.com/kurtmckee/chipshot'\n rev: 'v0.4.0'\n hooks:\n - id: 'update-headers'\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Set up game-winning headers!",
"version": "0.7.0",
"project_urls": {
"Documentation": "https://chipshot.readthedocs.io",
"Homepage": "https://github.com/kurtmckee/chipshot",
"Repository": "https://github.com/kurtmckee/chipshot"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e66b3620e14da20349b0a9ccd6ef31463a4b305455e2b3e2f34369913b1918c5",
"md5": "6a209822d2d38cf6b1dbf619600edad3",
"sha256": "de9bac2c63ea483eadf6149b1f373b1fd64ed4ddea66d19ef4feca35a22edea9"
},
"downloads": -1,
"filename": "chipshot-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a209822d2d38cf6b1dbf619600edad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19583,
"upload_time": "2023-12-09T14:46:57",
"upload_time_iso_8601": "2023-12-09T14:46:57.026969Z",
"url": "https://files.pythonhosted.org/packages/e6/6b/3620e14da20349b0a9ccd6ef31463a4b305455e2b3e2f34369913b1918c5/chipshot-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ebd4c6ec514e2785700b7d2a857003c66302d6cbee100e860eac79911c2d66f",
"md5": "e179a9c981deb49045f07e03af7259b8",
"sha256": "8ed7d05e2c13bdb7197af872ff9bef5b0057a7c16eec5e9f6c8df5c8ad70416b"
},
"downloads": -1,
"filename": "chipshot-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "e179a9c981deb49045f07e03af7259b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13390,
"upload_time": "2023-12-09T14:46:58",
"upload_time_iso_8601": "2023-12-09T14:46:58.267672Z",
"url": "https://files.pythonhosted.org/packages/6e/bd/4c6ec514e2785700b7d2a857003c66302d6cbee100e860eac79911c2d66f/chipshot-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 14:46:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kurtmckee",
"github_project": "chipshot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "chipshot"
}
JSON
