crlint 0.1.2

The project copyright linter

Project copyright linter

A small utility to maintain the copyright status of a project in the correct state.

Copyright format

• Python copyright format:

# Copyright (c) 20XX Celadon Development LLC, All rights reserved.
# Author Name Surname <[e-mail]>

• JavaScript copyright format:

// Copyright (c) 20XX Celadon Development LLC, All rights reserved.
// Author Name Surname <[e-mail]>

Installation

• install package via pip toolkit: pip install crtool
• configure utility use one of two available methods
• run the project copyright linting: crtool

Configuration

Configuration settings are applied in two ways: by setup.cfg file or .crlintrc file. The setup.cfg file has more high priority. To set an exclusion pattern to ignore some file formats, use a unix pattern written in one of the files you selected.

• configuration utility in the setup.cfg file must have such format:

[crlint]
patterns=*.json, *.txt

• configuration utility in the .crlintrc file must have such format:

[ignore]
patterns=*.json, *.txt

Integration with Bitbucket CI:

Add such step in your bitbucket-pipelines.yml file to run checking a project copyright:

pipelines:
  default:
    - step:
        name: Linting copyright
        image: python:3.7.2
        script:
          - pip install crtool
          - crlint

Update pip package

• Login to the PiPy repository
• Increase version in the setup file
• Create a python package dist
• Update package on the PyPi repository

# Create a package dist.
python setup.py sdist bdist_wheel

# Upload package to repository.
pip install twine
twine upload -u $CT_PYPI_USERNAME -p $CT_PYPI_PASSWORD  dist/*

Development

Setup git hook to linting the project before commit.

chmod a+x pre-commit && cp pre-commit .git/hooks

To run the test and verify the code, follow the commands below:

# To run the project linting.
flake8 crlint tests

# To run the project testing.
python -m coverage run -m unittest discover tests/
python -m coverage report -m