Skip to main content

A CLI to encourage (😅) people to update their dependencies!

Project description

rubrical

A Python CLI to encourage (😅) people to update their dependencies!

Supported package managers:

  • Jsonnet
  • More coming soon!

Installation

Package

Coming soon!

Docker

Coming soon!

Usage

rubrical [OPTIONS]
Option Default Value Description
--config rubrical.yaml Path to configuration file
--target Current folder Path to source code folder
--no-block n/a Don't error if blocks found
--repository-name Unset Repository name for reporting
--pr-id Unset PR ID for reporting
--gh-access-token Unset Github access token. Enables Github comments.
--gh-custom-url Unset Github Enterprise custom url e.g. https://github.custom.dev

Configuration

The rubrical.yaml file is used to configure checks for your application.

version: 1
package_managers:
  - name: jsonnet
    packages:
      - name: "xunleii/vector_jsonnet" # Name of the dependency
        block: v0.1.0  # If dependency is older than this, error.
        warn: v0.1.2  # If dependency is older than this, warn.

Reporting

Terminal

Comes for free!

Github

  1. Create a Github access token with Pull requests: Read and write permissions.
  2. Run rubrical with the --gh-access-token, --repository-name, and --pr-id flags.

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

rubrical-0.0.0.tar.gz (12.1 kB view hashes)

Uploaded Source

Built Distribution

rubrical-0.0.0-py3-none-any.whl (15.2 kB view hashes)

Uploaded Python 3

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