Skip to main content

Free program analysis focused on bugs that matter to you.

Project description

Bento logo


Free program analysis focused on bugs that matter to you.

Install, configure, and adopt Bento in seconds. Runs 100% locally.

PyPI PyPI - Downloads Issues welcome! Follow @r2cdev



Bento is a free and opinionated toolkit for gradually adopting linters¹ and program analysis² in your codebase. Be the bug-squashing advocate your team needs but (maybe) doesn’t deserve.

  • Find bugs that matter. Bento automatically enables and configures relevant analysis based on your dependencies and frameworks, and it will never report style-related issues. You won’t painstakingly configure your tooling.
  • Get started immediately. Bento doesn’t force you to fix all your preexisting issues today. Instead, you can archive them and address them incrementally when it makes sense for your project.
  • Go fast. Bento installs in 5 seconds and self-configures in less than 30. Its tools check your code in parallel, not sequentially.

Bento includes checks written by r2c and curated from Bandit, ESLint, Flake8, and their plugins. It runs on your local machine and never sends your code anywhere or to anyone.

gif demonstrating Bento running in a terminal

Installation

$ pip3 install bento-cli

Bento is for JavaScript, TypeScript, and Python projects. It requires Python 3.6+ and works on macOS Mojave (10.14) and Ubuntu 18.04+.

Usage

To get started right away with sensible defaults:

$ bento init && bento check

To set aside preexisting results so you only see issues in new code:

$ bento archive

Bento really sings when you run it automatically in your editor, as a commit hook (bento install-hook), or in CI.

Command Line Options

$ bento --help

Usage: bento [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show current Bento version.
  --agree    Automatically agree to terms of service.
  --help     Show this message and exit.

Commands:
  archive       Adds all current findings to the whitelist.
  check         Checks for new findings.
  disable       Disables a check.
  enable        Enables a check.
  init          Autodetects and installs tools.
  install-hook  Installs Bento as a git pre-commit hook.

Help and Community

  • Need help or want to share feedback? Reach out to us at support@r2c.dev. We’d love to hear from you! 💌
  • Join #bento in our community Slack for support, to talk with other users, and share feedback. 🤝
  • We’re fortunate to benefit from the contributions of the open source community and great projects such as Bandit, ESLint, Flake8, and their plugins. 🙏

License and Legal

Please refer to the terms and privacy document.



r2c logo

Copyright (c) r2c.


Changelog

This project adheres to Semantic Versioning.

[0.2.1] - 2019-10-24

Fixed

  • Fix an issue where cached results are not invalidated when a file changes on the root path.

[0.2.1] - 2019-10-29

Fixed

  • Quoted emails in git configuration do not break user registration.
  • Removed files properly invalidate results cache.
  • Python tools do not crawl node_modules.

[0.2.0] - 2019-10-23

Changed

  • Results are cached between runs. This means that an immediate rerun of bento will be much faster.
  • Broadened library compatibility, especially for common packages:
    • attrs from 18.2.0
    • packaging from 14.0
    • pre-commit from 1.0.0
  • r2c.eslint ignores .min.js files. Bento should only report issues in code, not built artifacts.
  • Telemetry endpoint uses bento.r2c.dev.

Added

  • Bento check will optionally run only on passed paths, using bento check [path] ....
  • Add r2c.pyre as a configurable tool. To enable, it must be manually configured in .bento.yml.
  • Formatters can be specified with short names, and these appear in the help text. For example, bento check --formatter json.
  • bento version is passed to telemetry backend.

Fixed

  • Tool does not crash if a git user does not have an email configured.
  • Fixed a regression that caused progress bars to hang after first tool completed.
  • Made fully compatible with Python 3.6.
  • Tool does not mangle .gitignore when that file lacks a trailing newline.

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

bento-cli-0.2.1.tar.gz (38.0 kB view details)

Uploaded Source

Built Distribution

bento_cli-0.2.1-py3-none-any.whl (48.9 kB view details)

Uploaded Python 3

File details

Details for the file bento-cli-0.2.1.tar.gz.

File metadata

  • Download URL: bento-cli-0.2.1.tar.gz
  • Upload date:
  • Size: 38.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for bento-cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 15f6b4d9d00266084c4a230272c2a387dd57ebb9f79f0f3de214a3ea1ee6252e
MD5 18611ea3e6afd25689b2ac1b5e33c0f3
BLAKE2b-256 4f65a690629c0ee8664a85ad94a3864b38fef232a293a5d245ab959285f58f3e

See more details on using hashes here.

File details

Details for the file bento_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: bento_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 48.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for bento_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9c50b0cf74fe76e9108aa45fc10621698aad8baa909a0ca1c52711298b8af037
MD5 85ad304c22b4b8beed4b857629a77494
BLAKE2b-256 beebac1514b615d4122b69df23ad6dfae7b9a4222e3bf3a9695352e04dd9faf8

See more details on using hashes here.

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