Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.15 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.15 KB

Source Radar

A tool to analyze source code and generate metrics.

Features

  • Support for multiple languages
  • Centralized configuration
  • Add support for new languages using plugins

Installation

We are working on a PyPI package, but for now you can install it using the following command:

Server:

$ pip install pip install -e "git+https://github.com/inputforge/source-radar#egg=source_radar&subdirectory=source_radar"

Client:

$ pip install pip install -e "git+https://github.com/inputforge/source-radar#egg=source_radar_client&subdirectory=source_radar_client"

Usage

Create a configuration file in the root of your project like this:

server = "http://localhost:5000"
project = "source-radar"
linters = ["ruff"]
roots = [
    "source_radar",
    "source_radar_client",
]

Then run the following command:

$ source-radar analyze

This will analyze the source code and print the results.

To upload the results to the server, run the following command:

$ source-radar upload

License

This project is licensed under the MIT License - see the LICENSE file for details.