| Name | lintro JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | A unified CLI tool for code formatting, linting, and quality assurance |
| upload_time | 2025-08-17 18:48:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.14,>=3.13 |
| license | MIT License
Copyright (c) 2024 Eitel Dagnin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
linting
formatting
code-quality
cli
python
javascript
yaml
docker
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Lintro
<img src="https://raw.githubusercontent.com/TurboCoder13/py-lintro/main/assets/images/lintro.png" alt="Lintro Logo" style="width:100%;max-width:800px;height:auto;display:block;margin:0 auto 24px auto;">
A comprehensive CLI tool that unifies various code formatting, linting, and quality assurance tools under a single command-line interface.
## What is Lintro?
Lintro is a unified command-line interface that brings together multiple code quality tools into a single, easy-to-use package. Instead of managing separate tools like Ruff, Prettier, Yamllint, and others individually, Lintro provides a consistent interface for all your code quality needs.
### Why Lintro?
- **🚀 Unified Interface**: One command to run all your linting and formatting tools
- **🎯 Consistent Output**: Beautiful, standardized output formats across all tools
- **🔧 Auto-fixing**: Automatically fix issues where possible
- **🐳 Docker Ready**: Run in isolated containers for consistent environments
- **📊 Rich Reporting**: Multiple output formats (grid, JSON, HTML, CSV, Markdown)
- **⚡ Fast**: Optimized execution with efficient tool management
- **🔒 Reliable**: Comprehensive test suite with 84% coverage
[](https://www.python.org/downloads/)
[](docs/coverage-setup.md)
[](LICENSE)
[](https://github.com/TurboCoder13/py-lintro/actions/workflows/test-and-coverage.yml)
[](https://github.com/TurboCoder13/py-lintro/actions/workflows/ci-lintro-analysis.yml)
[](https://github.com/TurboCoder13/py-lintro/actions/workflows/docker-build-publish.yml)
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/lintro/)
## Features
- **Unified CLI** for multiple code quality tools
- **Multi-language support** - Python, JavaScript, YAML, Docker, and more
- **Auto-fixing** capabilities where possible
- **Beautiful output formatting** with table views
- **Docker support** for containerized environments
- **CI/CD integration** with GitHub Actions
## Supported Tools
| Tool | Language/Format | Purpose | Auto-fix |
| ------------ | --------------- | -------------------- | -------- |
| **Ruff** | Python | Linting & Formatting | ✅ |
| **Darglint** | Python | Docstring Validation | - |
| **Prettier** | JS/TS/JSON | Code Formatting | ✅ |
| **Yamllint** | YAML | Syntax & Style | - |
| **Hadolint** | Dockerfile | Best Practices | - |
## Quick Start
### Installation
#### From PyPI (Recommended)
```bash
pip install lintro
```
#### Development Installation
```bash
# Clone and install in development mode
git clone https://github.com/TurboCoder13/py-lintro.git
cd py-lintro
pip install -e .
```
### Basic Usage
```bash
# Check all files for issues
lintro check
# Auto-fix issues where possible
lintro format
# Use grid formatting for better readability
lintro check --output-format grid
# Run specific tools only
lintro check --tools ruff,prettier
# List all available tools
lintro list-tools
```
## Docker Usage
### Quick Start with Published Image
```bash
# Run Lintro directly from GitHub Container Registry
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check
# With specific formatting
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check --output-format grid
# Run specific tools only
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check --tools ruff,prettier
```
### Development Setup
```bash
# Clone and setup
git clone https://github.com/TurboCoder13/py-lintro.git
cd py-lintro
chmod +x scripts/**/*.sh
# Run with local Docker build
./scripts/docker/docker-lintro.sh check --output-format grid
```
See [Docker Documentation](docs/docker.md) for detailed usage.
## Advanced Usage
### Output Formatting
```bash
# Grid format (recommended)
lintro check --output-format grid --group-by code
# Export to file
lintro check --output report.txt
# Different grouping options
lintro check --output-format grid --group-by file # Group by file
lintro check --output-format grid --group-by code # Group by error type
```
### Tool-Specific Options
```bash
# Exclude patterns
lintro check --exclude "migrations,node_modules,dist"
# Tool-specific options
lintro check --tool-options "ruff:--line-length=88,prettier:--print-width=80"
# Ruff fix configuration (fmt):
# By default, fmt applies both lint fixes and formatting for Ruff.
# Disable either stage as needed:
lintro format --tool-options ruff:lint_fix=False # format only
lintro format --tool-options ruff:format=False # lint fixes only
```
### CI/CD Integration
Lintro includes pre-built GitHub Actions workflows:
- **Automated code quality checks** on pull requests
- **Coverage reporting** with badges
- **Multi-tool analysis** across your entire codebase
See [GitHub Integration Guide](docs/github-integration.md) for setup instructions.
## Documentation
For comprehensive documentation, see our **[Documentation Hub](docs/README.md)** which includes:
- **[Getting Started](docs/getting-started.md)** - Installation and basic usage
- **[Docker Usage](docs/docker.md)** - Containerized development
- **[GitHub Integration](docs/github-integration.md)** - CI/CD setup
- **[Configuration](docs/configuration.md)** - Tool configuration options
- **[Contributing](docs/contributing.md)** - Developer guide
- **[Tool Analysis](docs/tool-analysis/)** - Detailed tool comparisons
## Development
```bash
# Run tests
./scripts/local/run-tests.sh
# Run Lintro on itself
./scripts/local/local-lintro.sh check --output-format grid
# Docker development
./scripts/docker/docker-test.sh
./scripts/docker/docker-lintro.sh check --output-format grid
```
For detailed information about all available scripts, see [Scripts Documentation](scripts/README.md).
## Dependencies
- **Renovate** for automated dependency updates
- **Python 3.13+** with UV package manager
- **Optional**: Docker for containerized usage
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Troubleshooting
### Common Issues
#### "Command not found: lintro"
**Solution**: Ensure Lintro is installed correctly:
```bash
pip install lintro
# or for development
pip install -e .
```
#### "Tool not found" errors
**Solution**: Install the required tools or use Docker:
```bash
# Install tools individually
pip install ruff darglint
npm install -g prettier
pip install yamllint
# or use Docker (recommended)
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check
```
#### Permission errors on Windows
**Solution**: Run as administrator or use WSL:
```bash
# Use WSL for better compatibility
wsl
pip install lintro
```
#### Docker permission issues
**Solution**: Add your user to the docker group:
```bash
sudo usermod -aG docker $USER
# Log out and back in
```
#### Slow performance
**Solution**: Use exclude patterns and specific tools:
```bash
# Exclude large directories
lintro check --exclude "node_modules,venv,.git"
# Run specific tools only
lintro check --tools ruff,prettier
```
### Getting Help
- 📖 **Documentation**: Check the [docs/](docs/) directory
- 🐛 **Bug Reports**: Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md)
- 💡 **Questions**: Use the [question template](.github/ISSUE_TEMPLATE/question.md)
- 🚀 **Feature Requests**: Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md)
## Contributing
We welcome contributions! See our [Contributing Guide](docs/contributing.md) for details on:
- Adding new tools
- Reporting bugs
- Submitting features
- Code style guidelines
Raw data
{
"_id": null,
"home_page": null,
"name": "lintro",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.13",
"maintainer_email": null,
"keywords": "linting, formatting, code-quality, cli, python, javascript, yaml, docker",
"author": null,
"author_email": "TurboCoder13 <turbocoder13@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c4/89/ea0a0704d55d860c8c26c57129517643c1b4caa762b7d1816a4717f8f13a/lintro-0.3.2.tar.gz",
"platform": null,
"description": "# Lintro\n\n<img src=\"https://raw.githubusercontent.com/TurboCoder13/py-lintro/main/assets/images/lintro.png\" alt=\"Lintro Logo\" style=\"width:100%;max-width:800px;height:auto;display:block;margin:0 auto 24px auto;\">\n\nA comprehensive CLI tool that unifies various code formatting, linting, and quality assurance tools under a single command-line interface.\n\n## What is Lintro?\n\nLintro is a unified command-line interface that brings together multiple code quality tools into a single, easy-to-use package. Instead of managing separate tools like Ruff, Prettier, Yamllint, and others individually, Lintro provides a consistent interface for all your code quality needs.\n\n### Why Lintro?\n\n- **\ud83d\ude80 Unified Interface**: One command to run all your linting and formatting tools\n- **\ud83c\udfaf Consistent Output**: Beautiful, standardized output formats across all tools\n- **\ud83d\udd27 Auto-fixing**: Automatically fix issues where possible\n- **\ud83d\udc33 Docker Ready**: Run in isolated containers for consistent environments\n- **\ud83d\udcca Rich Reporting**: Multiple output formats (grid, JSON, HTML, CSV, Markdown)\n- **\u26a1 Fast**: Optimized execution with efficient tool management\n- **\ud83d\udd12 Reliable**: Comprehensive test suite with 84% coverage\n\n[](https://www.python.org/downloads/)\n[](docs/coverage-setup.md)\n[](LICENSE)\n[](https://github.com/TurboCoder13/py-lintro/actions/workflows/test-and-coverage.yml)\n[](https://github.com/TurboCoder13/py-lintro/actions/workflows/ci-lintro-analysis.yml)\n[](https://github.com/TurboCoder13/py-lintro/actions/workflows/docker-build-publish.yml)\n[](https://github.com/astral-sh/ruff)\n[](https://pypi.org/project/lintro/)\n\n## Features\n\n- **Unified CLI** for multiple code quality tools\n- **Multi-language support** - Python, JavaScript, YAML, Docker, and more\n- **Auto-fixing** capabilities where possible\n- **Beautiful output formatting** with table views\n- **Docker support** for containerized environments\n- **CI/CD integration** with GitHub Actions\n\n## Supported Tools\n\n| Tool | Language/Format | Purpose | Auto-fix |\n| ------------ | --------------- | -------------------- | -------- |\n| **Ruff** | Python | Linting & Formatting | \u2705 |\n| **Darglint** | Python | Docstring Validation | - |\n| **Prettier** | JS/TS/JSON | Code Formatting | \u2705 |\n| **Yamllint** | YAML | Syntax & Style | - |\n| **Hadolint** | Dockerfile | Best Practices | - |\n\n## Quick Start\n\n### Installation\n\n#### From PyPI (Recommended)\n\n```bash\npip install lintro\n```\n\n#### Development Installation\n\n```bash\n# Clone and install in development mode\ngit clone https://github.com/TurboCoder13/py-lintro.git\ncd py-lintro\npip install -e .\n```\n\n### Basic Usage\n\n```bash\n# Check all files for issues\nlintro check\n\n# Auto-fix issues where possible\nlintro format\n\n# Use grid formatting for better readability\nlintro check --output-format grid\n\n# Run specific tools only\nlintro check --tools ruff,prettier\n\n# List all available tools\nlintro list-tools\n```\n\n## Docker Usage\n\n### Quick Start with Published Image\n\n```bash\n# Run Lintro directly from GitHub Container Registry\ndocker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check\n\n# With specific formatting\ndocker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check --output-format grid\n\n# Run specific tools only\ndocker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check --tools ruff,prettier\n```\n\n### Development Setup\n\n```bash\n# Clone and setup\ngit clone https://github.com/TurboCoder13/py-lintro.git\ncd py-lintro\nchmod +x scripts/**/*.sh\n\n# Run with local Docker build\n./scripts/docker/docker-lintro.sh check --output-format grid\n```\n\nSee [Docker Documentation](docs/docker.md) for detailed usage.\n\n## Advanced Usage\n\n### Output Formatting\n\n```bash\n# Grid format (recommended)\nlintro check --output-format grid --group-by code\n\n# Export to file\nlintro check --output report.txt\n\n# Different grouping options\nlintro check --output-format grid --group-by file # Group by file\nlintro check --output-format grid --group-by code # Group by error type\n```\n\n### Tool-Specific Options\n\n```bash\n# Exclude patterns\nlintro check --exclude \"migrations,node_modules,dist\"\n\n# Tool-specific options\nlintro check --tool-options \"ruff:--line-length=88,prettier:--print-width=80\"\n\n# Ruff fix configuration (fmt):\n# By default, fmt applies both lint fixes and formatting for Ruff.\n# Disable either stage as needed:\nlintro format --tool-options ruff:lint_fix=False # format only\nlintro format --tool-options ruff:format=False # lint fixes only\n```\n\n### CI/CD Integration\n\nLintro includes pre-built GitHub Actions workflows:\n\n- **Automated code quality checks** on pull requests\n- **Coverage reporting** with badges\n- **Multi-tool analysis** across your entire codebase\n\nSee [GitHub Integration Guide](docs/github-integration.md) for setup instructions.\n\n## Documentation\n\nFor comprehensive documentation, see our **[Documentation Hub](docs/README.md)** which includes:\n\n- **[Getting Started](docs/getting-started.md)** - Installation and basic usage\n- **[Docker Usage](docs/docker.md)** - Containerized development\n- **[GitHub Integration](docs/github-integration.md)** - CI/CD setup\n- **[Configuration](docs/configuration.md)** - Tool configuration options\n- **[Contributing](docs/contributing.md)** - Developer guide\n- **[Tool Analysis](docs/tool-analysis/)** - Detailed tool comparisons\n\n## Development\n\n```bash\n# Run tests\n./scripts/local/run-tests.sh\n\n# Run Lintro on itself\n./scripts/local/local-lintro.sh check --output-format grid\n\n# Docker development\n./scripts/docker/docker-test.sh\n./scripts/docker/docker-lintro.sh check --output-format grid\n```\n\nFor detailed information about all available scripts, see [Scripts Documentation](scripts/README.md).\n\n## Dependencies\n\n- **Renovate** for automated dependency updates\n- **Python 3.13+** with UV package manager\n- **Optional**: Docker for containerized usage\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Troubleshooting\n\n### Common Issues\n\n#### \"Command not found: lintro\"\n\n**Solution**: Ensure Lintro is installed correctly:\n\n```bash\npip install lintro\n# or for development\npip install -e .\n```\n\n#### \"Tool not found\" errors\n\n**Solution**: Install the required tools or use Docker:\n\n```bash\n# Install tools individually\npip install ruff darglint\nnpm install -g prettier\npip install yamllint\n# or use Docker (recommended)\ndocker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check\n```\n\n#### Permission errors on Windows\n\n**Solution**: Run as administrator or use WSL:\n\n```bash\n# Use WSL for better compatibility\nwsl\npip install lintro\n```\n\n#### Docker permission issues\n\n**Solution**: Add your user to the docker group:\n\n```bash\nsudo usermod -aG docker $USER\n# Log out and back in\n```\n\n#### Slow performance\n\n**Solution**: Use exclude patterns and specific tools:\n\n```bash\n# Exclude large directories\nlintro check --exclude \"node_modules,venv,.git\"\n\n# Run specific tools only\nlintro check --tools ruff,prettier\n```\n\n### Getting Help\n\n- \ud83d\udcd6 **Documentation**: Check the [docs/](docs/) directory\n- \ud83d\udc1b **Bug Reports**: Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md)\n- \ud83d\udca1 **Questions**: Use the [question template](.github/ISSUE_TEMPLATE/question.md)\n- \ud83d\ude80 **Feature Requests**: Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md)\n\n## Contributing\n\nWe welcome contributions! See our [Contributing Guide](docs/contributing.md) for details on:\n\n- Adding new tools\n- Reporting bugs\n- Submitting features\n- Code style guidelines\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Eitel Dagnin\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE. ",
"summary": "A unified CLI tool for code formatting, linting, and quality assurance",
"version": "0.3.2",
"project_urls": {
"Documentation": "https://github.com/TurboCoder13/py-lintro/docs",
"Homepage": "https://github.com/TurboCoder13/py-lintro",
"Source": "https://github.com/TurboCoder13/py-lintro"
},
"split_keywords": [
"linting",
" formatting",
" code-quality",
" cli",
" python",
" javascript",
" yaml",
" docker"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0777e74ba3664b5ada927f106928f902a501e4fbd943897b9afb1a80639a1435",
"md5": "a3906a8f4cc5106fad2962a3f49488c8",
"sha256": "6ccfd440842bd0f594d1b304c8721aa2c6e090c03d2007147230e482ecd47d38"
},
"downloads": -1,
"filename": "lintro-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3906a8f4cc5106fad2962a3f49488c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.13",
"size": 107699,
"upload_time": "2025-08-17T18:48:54",
"upload_time_iso_8601": "2025-08-17T18:48:54.489914Z",
"url": "https://files.pythonhosted.org/packages/07/77/e74ba3664b5ada927f106928f902a501e4fbd943897b9afb1a80639a1435/lintro-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c489ea0a0704d55d860c8c26c57129517643c1b4caa762b7d1816a4717f8f13a",
"md5": "8021df487942e388caff8751da345526",
"sha256": "791978a2378447b0b7729739dec661197a33c50fa3841b0b16a79891515139cc"
},
"downloads": -1,
"filename": "lintro-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "8021df487942e388caff8751da345526",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.13",
"size": 1219156,
"upload_time": "2025-08-17T18:48:56",
"upload_time_iso_8601": "2025-08-17T18:48:56.116073Z",
"url": "https://files.pythonhosted.org/packages/c4/89/ea0a0704d55d860c8c26c57129517643c1b4caa762b7d1816a4717f8f13a/lintro-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-17 18:48:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TurboCoder13",
"github_project": "py-lintro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "lintro"
}
