| Name | code-analyza JSON |
| Version |
0.0b1
JSON |
| download |
| home_page | |
| Summary | A Code Analyser package. |
| upload_time | 2023-04-18 12:52:13 |
| maintainer | |
| docs_url | None |
| author | Clifton Davies |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Clifton Davies 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. |
| keywords |
code analyser
linter
pep8
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Code Analyza
A code analyser package for Python.
## Getting Started
### Installation
Code Analyza is available via PyPi.
```bash
pip install code-analyza
```
### Usage
Run as a script:
```bash
code_analyza path/to/file/or/directory
```
Import as a module:
```python
from code_analyza.linter.checks import analyse
base_path = # set path/to/file/or/directory
issues = analyse(base_path)
```
## Style Conventions
Code Analyza currently implements 9 conventions as specified by the [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/). They include:
- Code Lay-out
- Indentation
- Maximum Line Length
- Blank Lines
- Comments
- Inline Comments
- Naming Conventions
- Class, Function and Variable Names
- Function and Method Parameters
- Semicolons
- Todos
- Default Arguments
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
## Support
Give a ⭐️ if you like this project!
## Acknowledgements
- [PEP 8](https://peps.python.org/pep-0008/)
- [Ruff](https://github.com/charliermarsh/ruff)
## 📝 Copyright & License
Copyright (c) 2023 Clifton Davies. This project is licensed under [MIT](https://opensource.org/licenses/MIT). See LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "code-analyza",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "code analyser,linter,pep8",
"author": "Clifton Davies",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d5/6b/cdc8c51d3a2c4b29f2be963bb3a3705ff6e7262cce5bfe7ac7f882cf37c3/code_analyza-0.0b1.tar.gz",
"platform": null,
"description": "# Code Analyza\n\nA code analyser package for Python.\n\n## Getting Started\n\n### Installation\n\nCode Analyza is available via PyPi.\n\n```bash\npip install code-analyza\n```\n\n### Usage\n\nRun as a script:\n\n```bash\ncode_analyza path/to/file/or/directory\n```\n\nImport as a module:\n\n```python\nfrom code_analyza.linter.checks import analyse\n\nbase_path = # set path/to/file/or/directory\nissues = analyse(base_path)\n```\n\n## Style Conventions\n\nCode Analyza currently implements 9 conventions as specified by the [PEP 8 \u2013 Style Guide for Python Code](https://peps.python.org/pep-0008/). They include: \n\n- Code Lay-out\n - Indentation\n - Maximum Line Length\n - Blank Lines\n- Comments\n - Inline Comments\n- Naming Conventions\n - Class, Function and Variable Names\n - Function and Method Parameters\n- Semicolons \n- Todos\n- Default Arguments\n\n## \ud83e\udd1d Contributing\n\nContributions, issues and feature requests are welcome!\n\n## Support\n\nGive a \u2b50\ufe0f if you like this project!\n\n## Acknowledgements\n\n- [PEP 8](https://peps.python.org/pep-0008/)\n- [Ruff](https://github.com/charliermarsh/ruff)\n\n## \ud83d\udcdd Copyright & License\n\nCopyright (c) 2023 Clifton Davies. This project is licensed under [MIT](https://opensource.org/licenses/MIT). See LICENSE file for details.",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Clifton Davies 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.",
"summary": "A Code Analyser package.",
"version": "0.0b1",
"split_keywords": [
"code analyser",
"linter",
"pep8"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c95582ed908c104393161a8be9dcd9b7d26d9f1d8ef7d12519d4b2b9ac7cc10c",
"md5": "6db3ad0bf52342b37eca9c9dda96be89",
"sha256": "0515a356e21e498211f9fa32de1fbc28db57378d49bf751ddbf2d9c93ecc4d6d"
},
"downloads": -1,
"filename": "code_analyza-0.0b1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6db3ad0bf52342b37eca9c9dda96be89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6214,
"upload_time": "2023-04-18T12:52:11",
"upload_time_iso_8601": "2023-04-18T12:52:11.324475Z",
"url": "https://files.pythonhosted.org/packages/c9/55/82ed908c104393161a8be9dcd9b7d26d9f1d8ef7d12519d4b2b9ac7cc10c/code_analyza-0.0b1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d56bcdc8c51d3a2c4b29f2be963bb3a3705ff6e7262cce5bfe7ac7f882cf37c3",
"md5": "4338b6c8a8e797c27fefb56e4fcec857",
"sha256": "1887f5a55b9fd55ed031658f77d5bc058965e6dc9325f6e908d9889bf1b6c445"
},
"downloads": -1,
"filename": "code_analyza-0.0b1.tar.gz",
"has_sig": false,
"md5_digest": "4338b6c8a8e797c27fefb56e4fcec857",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8101,
"upload_time": "2023-04-18T12:52:13",
"upload_time_iso_8601": "2023-04-18T12:52:13.191494Z",
"url": "https://files.pythonhosted.org/packages/d5/6b/cdc8c51d3a2c4b29f2be963bb3a3705ff6e7262cce5bfe7ac7f882cf37c3/code_analyza-0.0b1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-18 12:52:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "code-analyza"
}
