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: 'main'
    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.2.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

chipshot-0.2.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chipshot-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5cde04c0b8cd0bc2c741635bc93355ff8fa8397f54e56f139130193214bbfb6b
MD5 6f749301ce5a4d877bfbbc742ebaa009
BLAKE2b-256 35fc31a8514766b8c57f30b3cea41fe709f38eaed19914663fabe6ac68be631d

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: chipshot-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2a4c9421028d3514844a43a09a3d0ffedc255269e4038900d961ee24fbcd326
MD5 daddc29af4737d541bfe3a7e5de6207e
BLAKE2b-256 802be7ab3635aaca84f63cc3a10a4631798edebdaac3c42776efe11d5a966774

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