Metadata-Version: 2.1
Name: alxcheck
Version: 0.0.3
Summary: ALX test Suite. Shell Utility that checks for some of ALX Software Engineering Project Requirements
Home-page: https://github.com/Emmo00/alx-test
Author: Nwafor Emmanuel
Author-email: Emmanuel Nwafor <nwaforemmanuel005@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/Emmo00/alxcheck.git
Project-URL: Bug Tracker, https://github.com/Emmo00/alxcheck/issues
Keywords: alx,alx test,test,checks,test suite,green squares
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pycodestyle
Requires-Dist: colorama

# alxcheck

ALX test Suite. Shell Utility that checks for ALX Project Requirements

## Dependencies

- [`Python3`](https://www.python.org/downloads/)
- [`betty`](https://youtu.be/wDDKOOEPED0?ref=alxcheck)
- [`pycodestyle`](https://pycodestyle.pycqa.org/en/latest/)
- [`semistandard`](https://www.npmjs.com/package/semistandard)

## Features

`alxcheck` checks for the following:

### General

- `README.md` file present.
- `README.md` file is not empty.
- All files in the current folder and sub-folders end with a new line.

### C

- runs `betty` check.

> Note: You would have to make sure betty is installed. Check out [How To Install Betty](https://youtu.be/wDDKOOEPED0?ref=alxcheck)

### Python

- Python file is executable.
- *shebang* is present and at the top of the file (`#!/usr/bin/python3` or `#!/usr/bin/env python3`)
- Module documentation (docstrings)
- Function documentation (docstrings)
- Class documentation (docstrings)

### JavaScript

- Javascript file is executable
- *shebang* is present and at the top of the file (`#!/usr/bin/node` or `#!/usr/bin/env node`)
- `semistandard` check

> Note: you would have to install semistandard `npm install semistandard -g`

- `var` is not used.

## Installation

```bash
pip install alxcheck
```

or

```bash
python3 -m pip install alxcheck
```

## Usage

After installation, to use this package, just run it as a shell command

```bash
alxcheck
```

This starts the checks with the current working directory as the root of the project.

## Contributing

Feel free to contribute to the project by opening issues or submitting pull requests. Your feedback is valuable!

## License

This project is licensed under the [MIT License](./LICENSE).
