Skip to main content

Set up game-winning headers!

Project description

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:

[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:

# .pre-commit-config.yaml
repos:
  - repo: 'https://github.com/kurtmckee/chipshot'
    rev: 'v0.4.0'
    hooks:
      - id: 'update-headers'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chipshot-0.7.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

chipshot-0.7.0-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file chipshot-0.7.0.tar.gz.

File metadata

  • Download URL: chipshot-0.7.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for chipshot-0.7.0.tar.gz
Algorithm Hash digest
SHA256 8ed7d05e2c13bdb7197af872ff9bef5b0057a7c16eec5e9f6c8df5c8ad70416b
MD5 e179a9c981deb49045f07e03af7259b8
BLAKE2b-256 6ebd4c6ec514e2785700b7d2a857003c66302d6cbee100e860eac79911c2d66f

See more details on using hashes here.

Provenance

File details

Details for the file chipshot-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: chipshot-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for chipshot-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de9bac2c63ea483eadf6149b1f373b1fd64ed4ddea66d19ef4feca35a22edea9
MD5 6a209822d2d38cf6b1dbf619600edad3
BLAKE2b-256 e66b3620e14da20349b0a9ccd6ef31463a4b305455e2b3e2f34369913b1918c5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page