Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codacy/codacy-bandit

Bandit Python Tool for Codacy
https://github.com/codacy/codacy-bandit

bandit codacy codacy-bandit docker python review scala

Last synced: about 1 month ago
JSON representation

Bandit Python Tool for Codacy

Host: GitHub
URL: https://github.com/codacy/codacy-bandit
Owner: codacy
License: other
Created: 2016-05-24T11:16:56.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-08-02T17:14:54.000Z (5 months ago)
Last Synced: 2024-08-02T19:53:09.212Z (5 months ago)
Topics: bandit, codacy, codacy-bandit, docker, python, review, scala
Language: Scala
Size: 295 KB
Stars: 9
Watchers: 15
Forks: 12
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

# Codacy Bandit

This is the docker engine we use at Codacy to have [Bandit](https://github.com/PyCQA/bandit) support.
You can also create a docker to integrate the tool and language of your choice!
See the [codacy-engine-scala-seed](https://github.com/codacy/codacy-engine-scala-seed) repository for more information.

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/22833b5348fb4fdf80ea370560648c0b)](https://www.codacy.com/gh/codacy/codacy-bandit?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-bandit&utm_campaign=Badge_Grade)
[![Build Status](https://circleci.com/gh/codacy/codacy-bandit.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/codacy/codacy-bandit)

## Usage

You can create the docker by doing:

```bash
sbt universal:stage
docker build -t codacy-bandit .
```

The docker is ran with the following command:

```bash
docker run -it -v $srcDir:/src :
```

### Bump bandit version

* Change the `requirements.txt` file

### Generating documentation is obsolete
* Run `./scripts/generateDocs.sh`

## Docs

[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)

[Tool Developer Guide - Using Scala](https://support.codacy.com/hc/en-us/articles/207280379-Tool-Developer-Guide-Using-Scala)

## Test

We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.
You can follow the instructions there to make sure your tool is working as expected.

## What is Codacy

[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.

### Among Codacy’s features

- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, HipChat, Jira, YouTrack
- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories

Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.

Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.

## Free for Open Source

Codacy is free for Open Source projects.