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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file code_analyza-0.0b1.tar.gz.

File metadata

  • Download URL: code_analyza-0.0b1.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for code_analyza-0.0b1.tar.gz
Algorithm Hash digest
SHA256 1887f5a55b9fd55ed031658f77d5bc058965e6dc9325f6e908d9889bf1b6c445
MD5 4338b6c8a8e797c27fefb56e4fcec857
BLAKE2b-256 d56bcdc8c51d3a2c4b29f2be963bb3a3705ff6e7262cce5bfe7ac7f882cf37c3

See more details on using hashes here.

File details

Details for the file code_analyza-0.0b1-py3-none-any.whl.

File metadata

  • Download URL: code_analyza-0.0b1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for code_analyza-0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 0515a356e21e498211f9fa32de1fbc28db57378d49bf751ddbf2d9c93ecc4d6d
MD5 6db3ad0bf52342b37eca9c9dda96be89
BLAKE2b-256 c95582ed908c104393161a8be9dcd9b7d26d9f1d8ef7d12519d4b2b9ac7cc10c

See more details on using hashes here.

Supported by

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