Skip to content

Commit

Permalink
change name to lintmate
Browse files Browse the repository at this point in the history
  • Loading branch information
thesujai committed Aug 5, 2024
1 parent 16726dd commit edf2bf3
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[flake8]
max-line-length = 100
max-line-length = 110
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Linter-CLI
# lintmate

A command-line program that helps you check and fix your code. It leverages existing popular linting tools, allowing you to maintain high code quality effortlessly.

Expand All @@ -9,3 +9,45 @@ A command-line program that helps you check and fix your code. It leverages exis

- **For example, if you are working on a Python project and are confused about how to set up tools like flake8 or black.**
Just use this tool and it will handle everything for you, making your work easier and faster.

# Features

- Lint and autofix Python files
- Lint and autofix Yaml files
- Easily extendable to support more file types

# Installation

You can install Linter-CLI from PyPI.
- To install with Python linter:
```
pip install lintmate[python]
```

- To install with yaml linter:
```
pip install lintmate[yaml]
```

**All linter(yaml, python) can be used together**

# Usages

- Run lint for a single file
```
lintmate lint file_path/file.py
```

- Run lint for multiple files in a directory
```
lintmate lint dir/
```

- Run lint with autofix
```
lintmate lint --autofix <path/to/file>
```

# Contributing

Contributions are welcome! Please submit a pull request or create an issue for any bugs or feature requests.
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"
17 changes: 14 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ def read_requirements(file):


setup(
name="linter-cli",
name="lintmate",
version="0.1.0",
author="thesujai",
packages=find_packages(),
install_requires=read_requirements("requirements/base.txt"),
extras_require={
Expand All @@ -24,7 +23,19 @@ def read_requirements(file):
},
entry_points={
"console_scripts": [
"linter_cli = linter_cli.cli:main",
"lintmate= linter_cli.cli:main",
],
},
author="thesujai",
author_email="[email protected]",
description="A CLI tool for linting and formatting files. Without worying about any dependencies.",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
url="https://github.com/thesujai/linter-cli",
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.9",
)

0 comments on commit edf2bf3

Please sign in to comment.