| Name | alxcheck JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects |
| upload_time | 2024-01-29 12:15:31 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
alx
alx test
test
checks
test suite
green squares
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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)
- Parse and check for syntax error.
### JavaScript
- Javascript file is executable
> Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below
- *shebang* is present and at the top of the file (`#!/usr/bin/node` or `#!/usr/bin/env node`)
> Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below
- `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. This starts the checks with the current working directory as the root of the project.
```bash
alxcheck
```
If the project is a JavaScript project with node.js scripts, a command line switch can be used to enable the first two checks [listed above](#javascript).
```bash
alxcheck -js #shorthand version
```
or
```bash
alxcheck --nodejs-project #long version
```
## Contributing
Feel free to contribute to the project by opening [issues](https://github.com/Emmo00/alxcheck/issues) or submitting [pull requests](https://github.com/Emmo00/alxcheck/pulls). Your feedback is valuable!
## License
This project is licensed under the [MIT License](./LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "alxcheck",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "alx,alx test,test,checks,test suite,green squares",
"author": "",
"author_email": "Emmanuel Nwafor <nwaforemmanuel005@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/cb/55/1c4d19469a777d5adf9fe820962c52508a44f4d44e9b9dd9cd7c27f2893e/alxcheck-0.1.3.tar.gz",
"platform": null,
"description": "# alxcheck\n\nALX test Suite. Shell Utility that checks for ALX Project Requirements\n\n## Dependencies\n\n- [`Python3`](https://www.python.org/downloads/)\n- [`betty`](https://youtu.be/wDDKOOEPED0?ref=alxcheck)\n- [`pycodestyle`](https://pycodestyle.pycqa.org/en/latest/)\n- [`semistandard`](https://www.npmjs.com/package/semistandard)\n\n## Features\n\n`alxcheck` checks for the following:\n\n### General\n\n- `README.md` file present.\n- `README.md` file is not empty.\n- All files in the current folder and sub-folders end with a new line.\n\n### C\n\n- runs `betty` check.\n > Note: You would have to make sure betty is installed. Check out [How To Install Betty](https://youtu.be/wDDKOOEPED0?ref=alxcheck)\n\n### Python\n\n- Python file is executable.\n- *shebang* is present and at the top of the file (`#!/usr/bin/python3` or `#!/usr/bin/env python3`)\n- Module documentation (docstrings)\n- Function documentation (docstrings)\n- Class documentation (docstrings)\n- Parse and check for syntax error.\n\n### JavaScript\n\n- Javascript file is executable\n > Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below\n- *shebang* is present and at the top of the file (`#!/usr/bin/node` or `#!/usr/bin/env node`)\n > Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below\n- `semistandard` check\n > Note: you would have to install semistandard `npm install semistandard -g`\n- `var` is not used.\n\n## Installation\n\n```bash\npip install alxcheck\n```\n\nor\n\n```bash\npython3 -m pip install alxcheck\n```\n\n## Usage\n\nAfter installation, to use this package, just run it as a shell command. This starts the checks with the current working directory as the root of the project.\n\n```bash\nalxcheck\n```\n\nIf the project is a JavaScript project with node.js scripts, a command line switch can be used to enable the first two checks [listed above](#javascript).\n\n```bash\nalxcheck -js #shorthand version\n```\n\nor\n\n```bash\nalxcheck --nodejs-project #long version\n```\n\n## Contributing\n\nFeel free to contribute to the project by opening [issues](https://github.com/Emmo00/alxcheck/issues) or submitting [pull requests](https://github.com/Emmo00/alxcheck/pulls). Your feedback is valuable!\n\n## License\n\nThis project is licensed under the [MIT License](./LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/Emmo00/alxcheck/issues",
"Homepage": "https://github.com/Emmo00/alxcheck.git"
},
"split_keywords": [
"alx",
"alx test",
"test",
"checks",
"test suite",
"green squares"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c2b43b2ebceb1ae78bb1cd236fd82ef696e1e8e091d69e86f3558cdc0c516fca",
"md5": "5bd96a745fcb0d241c1aa2ff23eaa9ee",
"sha256": "89dce95257dc289a7d8caca23b60a60c031981eb0c08cabec7d6771e0310df51"
},
"downloads": -1,
"filename": "alxcheck-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5bd96a745fcb0d241c1aa2ff23eaa9ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10670,
"upload_time": "2024-01-29T12:15:29",
"upload_time_iso_8601": "2024-01-29T12:15:29.865412Z",
"url": "https://files.pythonhosted.org/packages/c2/b4/3b2ebceb1ae78bb1cd236fd82ef696e1e8e091d69e86f3558cdc0c516fca/alxcheck-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb551c4d19469a777d5adf9fe820962c52508a44f4d44e9b9dd9cd7c27f2893e",
"md5": "dade4939e9c6800396254e9cb8c86cc3",
"sha256": "37cef73f6ab1e5abf88b6896878d8c84e85209976462128891798c73621231eb"
},
"downloads": -1,
"filename": "alxcheck-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "dade4939e9c6800396254e9cb8c86cc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8081,
"upload_time": "2024-01-29T12:15:31",
"upload_time_iso_8601": "2024-01-29T12:15:31.460722Z",
"url": "https://files.pythonhosted.org/packages/cb/55/1c4d19469a777d5adf9fe820962c52508a44f4d44e9b9dd9cd7c27f2893e/alxcheck-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 12:15:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Emmo00",
"github_project": "alxcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "alxcheck"
}
