Metadata-Version: 2.1
Name: pycodehealth
Version: 0.0.1b0
Summary: PyCodeHealth is a Python package for high-quality code maintenance, providing Static Code Analysis tools, automatic formatting, and a web-based Dashboard. It streamlines workflow and improves code quality, allowing users to choose their preferred linter, type checker, and formatting tool.
Author: Ricardo Leal
Author-email: rick.leal420@gmail.com
Maintainer: Ricardo Leal
Maintainer-email: ricardo.lealpz@gmail.com
License: MIT
Project-URL: Bug Reports, https://github.com/ricardoleal20/PyCodeHealth/issues
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Requires-Python: >=3.8, <4
Description-Content-Type: text/markdown

<p align="center">
    <img src="web_application/frontend/img/full_logo.png" width="60%" height="60%"/>
</p>
<p align="center">
    <b>Ensuring high code quality has never been more accessible.</b>
</p>

![PyPi version](https://img.shields.io/pypi/v/pycodehealth?label=version&logo=PyPi&style=for-the-badge)
![Python versions supported](https://img.shields.io/pypi/pyversions/pycodehealth?label=Python%20Versions%20Supported&logo=Python&style=for-the-badge)
![Deployed](https://img.shields.io/github/actions/workflow/status/ricardoleal20/PyCodeHealth/publish.yml?branch=main&label=LAST%20VERSION%20DEPLOYED%20%F0%9F%9A%80&logo=Github&style=for-the-badge)
![License](https://img.shields.io/github/license/ricardoleal20/PyCodeHealth?color=%23808000&label=%F0%9F%93%84%20LICENSE&style=for-the-badge)

This package provides Static Code Analysis tools and a web-based Dashboard. Integrate Pylint, MyPy, and more to monitor code quality and streamline workflow for high-quality Python code.

## Installation

To install `PyCodeHealth`, you can do it through pip:

```
pip install pycodehealth
```

Please consider that it requires `Python >=3.8`

## Usage

To run the web application locally, just use the following command:

```
python -m web_application.app --r True
```

#### __HELP SECTION STILL ON WORK__.

## Contributing

Everyone can contribute. Before contributing, please read our [code of conduct](docs/CODE_OF_CONDUCT.md).

To contribute to `PyCodeHealth`, follow these steps:

1. Fork this repository.
2. Create a new branch.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Create a pull request.

## License

Project Name is released under the [MIT License](LICENSE).
