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.2.tar.gz (25.2 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.2-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: licenser_h-0.2.tar.gz
  • Upload date:
  • Size: 25.2 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.2.tar.gz
Algorithm Hash digest
SHA256 5c2d0a399c02b03d473648d5a8059c1e8aa260c604ad12f8a6931545610d97b4
MD5 53c365018f62ae22d357720996dda596
BLAKE2b-256 a02689a49690d2065b5e6131191b18c009f1dac16144e79134105f214ae5cbef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: licenser_h-0.2-py3-none-any.whl
  • Upload date:
  • Size: 28.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bba986765268be23a63d965ebbe4e5fd6afd0e1a204cc5d03d1a6fb9c660e7d1
MD5 8ef1f6b07da3883cea3ba760faf5e3c7
BLAKE2b-256 e4c8f1f57b89e4b852a0f07ca41863843613874ceabdb276f25e453509cfe0a5

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