Giter Club home page Giter Club logo

staticcodeanalysisforpython's Introduction

Static Code Analysis for Python – A graphical representation of Pylint & SonarQube

This project collects the code analysis results from two different tools, Pylint and SonarQube, and provides a meaningful interface that can be used to analyze the software quality of projects written in Python.

The different types of issues provided by these tools are combined in order to obtain a complete report regarding the code quality of the application under analysis, providing a collection of charts and graphical representations, which will indicate the code areas that can be improved, the files with most of the issues, the types of issues and the concrete code areas where these are located, allowing users to easily find and fix them.

This tool also provides the ability to compare previous versions of the analysis of the same application, which punctually indicates the issues solved and it is therefore, a great support in the code review process.

Structure

It contains two applications, representing the backend and frontend parts of the tool:

  • pylint-findings-service - provides and API with CRUD operations on the issues database. Handles all the backend requests over the database data.
  • frontend-app - consists of the user interface which provides ways to configure and analyze projects and presents graphically the issues detected, allowing users to manipulate them.

MongoDB Cloud is used for storing the application data.

🌈 Preview

🚀 Technologies & Modules

  • NestJS
  • React

🤔 Installation

Clone the project locally using command:

git clone https://github.com/SavuVeronica/StaticCodeAnalysisforPython.git

Run npm install in both backend and frontend applications in order to install the required dependencies.

💡 How To Run

  1. Run the backend service
cd pylint-findings-service
nest start
  1. Run the frontend service
cd frontend-app
npm start

👤 Author

🤓 Savu Veronica Alexandra / [email protected]

staticcodeanalysisforpython's People

Contributors

savuveronica avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.