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.5.0.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

chipshot-0.5.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chipshot-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a060e1b26a5bd0ca962f9a3ec8a8772dfc7d81ac8dbaa1ca82e6f1091c3c1410
MD5 0c2b4d1439c4b8f988471ad2e4dea212
BLAKE2b-256 d34d46341e53d2d4c1a201ead53be8466bd823060809bb420b59e48fdc94707a

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for chipshot-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5ff3cf9ab3cd569a266941fd038745f6e90c5e8122db7a0ad612fbba83f32a3
MD5 e713f1927ec748462c42b2ca2b9175c5
BLAKE2b-256 3e2f3fc7a383696dcccbeed8536368ca56130c46875ea2331fd267e2ad2b1c67

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