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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chipshot-0.4.0.tar.gz
Algorithm Hash digest
SHA256 302799bc550445d998c88cd62a3a7f963cbf8f56601f2dd2105609992ae94c50
MD5 ad8d86b8bd41d0c9d05541223b30129a
BLAKE2b-256 dfed8f6ddfdf9359ecd20810a7f0e9be818f995e23a7a5b8883857a751c93ec2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: chipshot-0.4.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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 972a150115d6ffb2672517ab883ba17dac48123030b9ff28843de70cda10ec9a
MD5 46d0fe80939b4fa918e5f0428fd097fd
BLAKE2b-256 1bb8fa3afed56aa009b189c2516590de89f6efbdf4fca7a58852d9d78356c48b

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