Metadata-Version: 2.4
Name: sakthipulse
Version: 0.1.0
Summary: A beginner-friendly health checker for Python projects
Author: Sakthi
License-Expression: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# SakthiPulse 💓

**Check the pulse of your Python project.**

SakthiPulse is a beginner-friendly Python project health checker that scans a project for basic structural issues and generates a readable health report.

## Features

- Check whether `README.md` exists.
- Check whether a `tests/` directory exists.
- Count Python files in the project.
- Detect empty Python files.
- Generate a readable project health report.
- Run checks directly from the terminal.
- Includes automated tests.

## Requirements

- Python 3.9 or newer

## Installation

SakthiPulse is currently under development and has not necessarily been published to PyPI.

To use it from a local clone:

```bash
python -m pip install -e .
```

Run this command from the project's root directory.

## Usage

Check the current directory:

```bash
sakthipulse .
```

Check a specific project directory:

```bash
sakthipulse "C:\path\to\your\project"
```

View available command options:

```bash
sakthipulse --help
```

## Python API

You can also use SakthiPulse in Python code:

```python
from sakthipulse import analyze_project, format_report

report = analyze_project(".")
print(format_report(report))
```

Check for a README separately:

```python
from sakthipulse import check_readme

print(check_readme("."))
```

## Example Report

```text
SakthiPulse - Project Health Report
-----------------------------------
Overall status:  GOOD
README.md:       Found
Tests folder:    Found
Python files:    5
Empty files:     0
```

The `GOOD` status means the configured checks passed. `NEEDS ATTENTION` means at least one check needs attention. This is a basic structural check, not a guarantee of code quality or security.

## Run Tests

From the project root, run:

```bash
python -m unittest discover -s tests -v
```

## Project Status

SakthiPulse is an early-stage project. Features and documentation may evolve as development continues.

## License

This project is intended to use the MIT License. See `LICENSE` for the license terms once that file has been added.
