Skip to main content

A simple tool for adding licenses and license headers to your projects.

Project description

Licenser

A Python tool to add or update license headers in your project files.

Description

Licenser is a command-line utility designed to automate the process of adding or updating license headers in your project's source code files. It supports multiple programming languages and license types, ensuring that your code complies with the licensing requirements of your choice.

Features

  • Supports Multiple Licenses:
    • MIT License
    • Apache License 2.0
    • GNU General Public License v3.0
    • BSD 2-Clause Simplified License
  • Multi-language Support:
    • Python, Shell Script, C, C++, Java, JavaScript, C#, Go, Ruby, PHP, HTML, XML, CSS, and more.
  • Automatic Detection and Replacement:
    • Detects existing license headers and replaces them.
    • Only updates the license header at the top of the file without affecting other comments.
  • Customizable Placeholders:
    • Replaces placeholders like |year|, |author|, |projectname|, and |projectnamecaps| with actual values.

Installation

Prerequisites

  • Python 3.6 or higher
  • pip package manager

Using setup.py

You can install Licenser by cloning the repository and running the setup.py script:

# Clone the repository
git clone https://github.com/yummydirtx/licenser-h.git
cd licenser-h

# Install the package
python setup.py install

Using pip

Licenser is available on PyPI, and you can install it directly:

pip install licenser-h

Usage

Command-Line Interface

Run the Licenser tool:

licenser-h

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

licenser_h-0.1.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

licenser_h-0.1-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file licenser_h-0.1.tar.gz.

File metadata

  • Download URL: licenser_h-0.1.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for licenser_h-0.1.tar.gz
Algorithm Hash digest
SHA256 edfdd209bbcd2161a3dc3dbc9a4837f772d2de12a16702ea86dc8d41555664c4
MD5 b37db8defa42f8e9dad4a84731647691
BLAKE2b-256 bfde3c7f014ed23c065f20767c0ac02cd4586f1382a68d4aac2613077f7cfa1f

See more details on using hashes here.

File details

Details for the file licenser_h-0.1-py3-none-any.whl.

File metadata

  • Download URL: licenser_h-0.1-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for licenser_h-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a94436d27a02441920e1bcd2576ca57badee071aec2c3e648452603b8a5b78ea
MD5 19840be61817733f15aac4fa578507fa
BLAKE2b-256 75c0b505042ab1f934a29cdf958b4916e71c0e2dc3687c1967ce7fd98026ae31

See more details on using hashes here.

Supported by

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