python-linting

GitHub Action to perform Python linting with Black, Pylint, and MyPy.

Features

• 🐍 Flexible Python version support - Specify any Python version using actions/setup-python
• 📦 Custom requirements - Install additional dependencies from a requirements file
• 🔍 Comprehensive linting - Run Pylint, Black, and MyPy in a single action
• 📊 Detailed reporting - View results in GitHub Actions summary
• 🏷️ SVG badge generation - Automatically generate and commit linting badges to your repository
• 📝 Automatic README updates - Automatically insert badge references into your README.md

Usage

Basic Example

- name: Python Linting
  uses: thoughtparametersllc/python-linting@v1

Advanced Example

- name: Python Linting
  uses: thoughtparametersllc/python-linting@v1
  with:
    python-version: '3.11'
    requirements-file: 'requirements.txt'
    pylint_options: '--max-line-length=120'
    black_options: '--line-length=120'
    mypy_options: '--strict'
    generate-badges: 'true'
    badges-directory: '.github/badges'

With Badge Generation and README Update

Enable badge generation and automatic README updates to have the action manage your linting badges:

- name: Python Linting
  uses: thoughtparametersllc/python-linting@v1
  with:
    generate-badges: 'true'
    update-readme: 'true'
    readme-path: 'README.md'
    badge-style: 'path'  # or 'url' for GitHub raw URLs

When generate-badges is enabled, SVG badges will be automatically generated and committed to your repository.

When update-readme is enabled, the action will automatically insert badge references into your README.md:

• Badges are inserted after the title with special markers
• You can customize the README path and badge style (relative paths or GitHub URLs)
• The script preserves existing content and only updates the badge section

Manual Badge References (if not using update-readme):

![Pylint](.github/badges/pylint.svg)
![Black](.github/badges/black.svg)
![MyPy](.github/badges/mypy.svg)

Inputs

Input	Description	Required	Default
python-version	Python version to use for linting	No	3.x
requirements-file	Path to requirements file for additional dependencies	No	''
pylint_options	Additional options to pass to pylint	No	''
black_options	Additional options to pass to black	No	''
mypy_options	Additional options to pass to mypy	No	''
generate-badges	Generate and commit SVG badges to the repository	No	false
badges-directory	Directory where badge SVG files will be saved	No	.github/badges
update-readme	Automatically update README.md with badge references	No	false
readme-path	Path to README.md file to update with badges	No	README.md
badge-style	Badge style: 'url' for GitHub URLs or 'path' for relative paths	No	path

Development

This repository includes comprehensive GitHub workflows for CI/CD:

• Test Action: Validates all action features across multiple Python versions
• Lint & Test: Ensures code quality with Pylint, Black, MyPy, and Flake8
• Changelog Check: Requires changelog updates for substantive changes
• Release & Marketplace: Automated semantic versioning and tagging
• Security Audit: Daily security scans with CodeQL, Bandit, and dependency checks
• Dependabot: Automated dependency updates

For detailed workflow documentation, see .github/WORKFLOWS.md.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Update CHANGELOG.md under the [Unreleased] section
5. Ensure all tests pass
6. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.