Metadata-Version: 2.1
Name: cligon
Version: 1.0.0
Summary: A small program to check the status of URLs
Home-page: https://github.com/rogercyyu/cligon-url-checker
Author: Roger Yu
Author-email: rogeryu27@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: appdirs (==1.4.4)
Requires-Dist: attrs (==20.3.0)
Requires-Dist: black (==20.8b1)
Requires-Dist: certifi (==2020.6.20)
Requires-Dist: cfgv (==3.2.0)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: click (==7.1.2)
Requires-Dist: coverage (==5.3)
Requires-Dist: distlib (==0.3.1)
Requires-Dist: filelock (==3.0.12)
Requires-Dist: flake8 (==3.8.4)
Requires-Dist: identify (==1.5.9)
Requires-Dist: idna (==2.10)
Requires-Dist: iniconfig (==1.1.1)
Requires-Dist: mccabe (==0.6.1)
Requires-Dist: mypy-extensions (==0.4.3)
Requires-Dist: nodeenv (==1.5.0)
Requires-Dist: packaging (==20.4)
Requires-Dist: pathspec (==0.8.0)
Requires-Dist: pluggy (==0.13.1)
Requires-Dist: pre-commit (==2.8.2)
Requires-Dist: py (==1.9.0)
Requires-Dist: pycodestyle (==2.6.0)
Requires-Dist: pyflakes (==2.2.0)
Requires-Dist: pyparsing (==2.4.7)
Requires-Dist: pytest (==6.1.2)
Requires-Dist: PyYAML (==5.3.1)
Requires-Dist: regex (==2020.10.28)
Requires-Dist: requests (==2.24.0)
Requires-Dist: responses (==0.12.1)
Requires-Dist: six (==1.15.0)
Requires-Dist: toml (==0.10.2)
Requires-Dist: typed-ast (==1.4.1)
Requires-Dist: typing-extensions (==3.7.4.3)
Requires-Dist: urllib3 (==1.25.11)
Requires-Dist: virtualenv (==20.1.0)

# C.L.I.G.O.N

## Introduction

C.L.I.G.O.N or Cligon is an acronym that stands for Check if Link Is Good Or Not.
It is designed to check all website links inside a file. This program was written in Python 3.8.2.
It will return a list of good, bad, or unknown URL statuses.
- good urls are status code 200.
- bad urls are status codes 400 or 404.
- unknowns are status codes that aren't bad or good.

## Usage
For prerequisites please see [CONTRIBUTING](./CONTRIBUTING.md).

To use Cligon, please run in a terminal of your choice:
```bash
python3 cligon.py [file name]
```
Or, if executable privileges are invoked in a Linux environment (chmod +x cligon):
```bash
./cligon [file name]
```
Ensure you make a copy of cligon.py (cp cligon.py cligon) to execute the command above.

Additionally, instructions and options can be viewed by running Cligon without any arguments.

## Features
- Colorized output: good = green, red = back, grey/white = unknown
- Version number argument
- Parallelism / Multi-threading (It's fast-ish)
- Grabs HEAD only
- URL timeout (default 2.5 milliseconds)
- Output JSON format
- Output only good or bad urls

## License

MIT


