Metadata-Version: 2.1
Name: manaisys-style-guide
Version: 0.2.2
Summary: Company-wide Python linting & formatting standards
License: MIT
Author: Pranjal Singh Rajput
Author-email: pranjalsrajput@gmail.com
Requires-Python: >=3.9,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: black (>=25.1.0,<26.0.0)
Requires-Dist: darglint (>=1.8.1,<2.0.0)
Requires-Dist: docformatter (>=1.7.7,<2.0.0)
Requires-Dist: isort (>=6.0.1,<7.0.0)
Requires-Dist: mypy (>=1.17.1,<2.0.0)
Requires-Dist: pre-commit (>=3.0,<4.0)
Requires-Dist: pydocstyle (>=6.3.0,<7.0.0)
Requires-Dist: ruff (>=0.12.10,<0.13.0)
Requires-Dist: typer (>=0.16.1,<0.17.0)
Description-Content-Type: text/markdown

# ManAISys Python Style Guide

This tool is designed to help you maintain a consistent coding style in your Python projects. It checks for common style issues and enforces best practices.

## Tools Used
- **Ruff**: A fast Python linter and formatter.
- **Black**: The uncompromising Python code formatter.
- **isort**: A Python utility for sorting imports.
- **mypy**: An optional static type checker for Python.
- **pydocstyle**: A documentation style checker for Python docstrings.
- **darglint**: A docstring style checker for Python.
- **docformatter**: A tool to format docstrings in Python.

## Installation

Run the following command to install the required tools:

## Using pip

```bash
pip install manaisys-style-guide
```

## Using Poetry

```bash
poetry add manaisys-style-guide
```

## Usage
You can run the style checks and formatting tools using the following commands:
(with Poetry use `poetry run style-guide <command>`)

```bash
style-guide format
style-guide format_docs
style-guide typecheck
style-guide lint
style-guide lint_docs
style-guide all
```
