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 directory that will contain your header template. For example, the directory might be named assets/headers.

Then, create a text file that will contain your header template, such as global.txt. You can use {{ year }} as a stand-in for the current year.

Copyright 2021-{{ date }} Developer or Company
Released under the terms of the MIT license.
SPDX-License-Identifier: MIT

Next, add the following configuration to pyproject.toml:

[tool.chipshot]
template_root = "assets/headers"
template = "global.txt"

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.

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

Uploaded Source

Built Distribution

chipshot-0.1.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chipshot-0.1.0.tar.gz
  • Upload date:
  • Size: 10.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.1.0.tar.gz
Algorithm Hash digest
SHA256 516051d086e6a13b97f25de0acbfdc91cd681d7706da8d0f8c287c8bc99a758a
MD5 a4d72fa3c6ff51612111d11fcde34706
BLAKE2b-256 db2dc1b555752f3a46343bac1e92ac4c73b839d139230e102331c1844ead84d1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: chipshot-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2e669c42d07f57aeb3abd86d794b22f70c850389708c91e77cba1147afe3301
MD5 2dcd5fb24c108349ff0ee0be953c8c86
BLAKE2b-256 2df2ebd0ae419dd45095cde9ac7781865c825f57bdc5b6b40ccccb569337c496

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