Skip to main content

A Code Analyser package.

Project description

Code Analyza

A code analyser package for Python.

Getting Started

Installation

Code Analyza is available via PyPi.

pip install code-analyza

Usage

Run as a script:

code_analyza path/to/file/or/directory

Import as a module:

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. 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

📝 Copyright & License

Copyright (c) 2023 Clifton Davies. This project is licensed under MIT. See LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

code_analyza-0.0b1.tar.gz (8.1 kB view hashes)

Uploaded Source

Built Distribution

code_analyza-0.0b1-py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page