Metadata-Version: 2.1
Name: rubrical
Version: 0.0.2
Summary: A CLI to encourage (😅) people to update their dependencies!
Home-page: https://github.com/ivanklee86/rubrical
License: 	MPL-2.0
Author: Ivan Lee
Author-email: ivanklee86@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Build Tools
Requires-Dist: pydantic (>=1.10.4,<2.0.0)
Requires-Dist: pygithub (>=1.58.0,<2.0.0)
Requires-Dist: python-benedict (>=0.29.1,<0.30.0)
Requires-Dist: semver (>=2.13.0,<3.0.0)
Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
Project-URL: Repository, https://github.com/ivanklee86/rubrical
Description-Content-Type: text/markdown

# 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

```bash
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.

```yaml
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.

