{"id":24129303,"url":"https://github.com/emmo00/alxcheck","last_synced_at":"2025-06-10T14:04:53.295Z","repository":{"id":207580345,"uuid":"718777842","full_name":"Emmo00/alxcheck","owner":"Emmo00","description":"ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects ","archived":false,"fork":false,"pushed_at":"2024-01-29T12:14:15.000Z","size":38,"stargazers_count":20,"open_issues_count":2,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-23T22:09:21.224Z","etag":null,"topics":["alx","alx-africa","alxswe","checker","checks","green-squares","tests"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/alxcheck/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Emmo00.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-11-14T19:28:28.000Z","updated_at":"2025-03-03T18:56:23.000Z","dependencies_parsed_at":"2024-01-26T22:27:13.009Z","dependency_job_id":"9100218d-77c2-46ad-862d-053e8745a4a1","html_url":"https://github.com/Emmo00/alxcheck","commit_stats":null,"previous_names":["emmo00/alxcheck"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmo00%2Falxcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmo00%2Falxcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmo00%2Falxcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmo00%2Falxcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Emmo00","download_url":"https://codeload.github.com/Emmo00/alxcheck/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmo00%2Falxcheck/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259088492,"owners_count":22803645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alx","alx-africa","alxswe","checker","checks","green-squares","tests"],"created_at":"2025-01-11T19:31:17.419Z","updated_at":"2025-06-10T14:04:53.220Z","avatar_url":"https://github.com/Emmo00.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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  \u003e 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  \u003e 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  \u003e Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below\n- `semistandard` check\n  \u003e 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmo00%2Falxcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femmo00%2Falxcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmo00%2Falxcheck/lists"}