Metadata-Version: 2.4
Name: osready
Version: 0.1.1
Summary: Checks whether a repository is ready for a pull request.
Author: Pankaj Kandpal, Karishma Mandal
License: MIT License
        
        Copyright (c) 2026 Open Source Club
        
        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.
        
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# OpenSourceReady (`osready`)

A command-line tool that checks whether your repository is ready for
your first open-source pull request — and tells you exactly what to
fix if it isn't.

```
$ osready check .

OpenSourceReady report
========================================
[FAIL] Git identity configured (high)
       -> Missing Git config: user.name, user.email. Fix with: ...
[PASS] README present (medium)
[PASS] No hardcoded secrets (high)
[FAIL] Tests present (low)
       -> No tests folder or test files found. ...
========================================
Readiness score: 7/10
```

## Install

```
git clone <this-repo-url>
cd osready
pip install -e .
```

## Usage

```
osready check .      # run all checks against the current folder
osready fix .         # auto-generate simple missing files (CONTRIBUTING.md)
```

## How it's organized

```
osready/
  models.py            # the CheckResult shape every check returns
  checks/
    git_checks.py       # Git config/state checks
    doc_checks.py        # README/LICENSE/CONTRIBUTING checks
    security_checks.py   # hardcoded-secret scanning
    test_checks.py       # "do tests exist" checks
    __init__.py           # the registry — collects all categories
  reports/
    scorer.py             # turns results into a score out of 10
    terminal_report.py    # prints the report
  fixes/
    fix_contributing.py   # auto-generates missing files
  cli.py                   # wires it all together
```

Every check is a small, independent function with the same contract:
it takes a repo path and returns one `CheckResult`. That's what makes
this a good project to practice contributing to — see
[CONTRIBUTING.md](CONTRIBUTING.md) and [ISSUES.md](ISSUES.md) for how
to add your own.

## Why only one check per category?

This is v1, and it's meant to be a starting skeleton, not a finished
tool. Every category has exactly one check implemented so there's
real, obvious room for the next contributor — that's the whole point
of this being a club project. See `ISSUES.md` for the backlog.
