Metadata-Version: 2.1
Name: muscle-musedev
Version: 0.0.4
Summary: A CLI for running Muse jobs
Home-page: https://gitlab.com/musedev/muscle
Author: MuseDev
Author-email: support@emuse.dev
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# muscle

The Muse On-Demand CLI Tool 

## Requirement
1. Have [pipenv installed](https://pypi.org/project/pipenv/)
2. Run `pipenv install` once in the current directory to ensure the availability of dependencies 
3. Set *environment variable* `MUSEDEV_TOKEN` with your JWT token (alternatively, set it in the `--token` option of each command)

## Usage
`./muscle --help`
```
Usage: muscle [OPTIONS] COMMAND [ARGS]...

Options:
  --token TEXT  Overrides environment variable MUSEDEV_TOKEN
  --help        Show this message and exit.

Commands:
  analyze  (--help for subcommand usage)
  status   (--help for subcommand usage)
  results   (--help for subcommand usage)
```
`./muscle analyze --help`
```
Usage: muscle analyze [OPTIONS] OWNER REPO

Options:
  --branch TEXT  The branch to analyze, default to 'master'
  --commit TEXT  Hash of the commit to analyze, overrides --branch
  --help         Show this message and exit.
```
`./muscle status --help `
```
Usage: muscle status [OPTIONS] [JOB_ID]...

Options:
  --help  Show this message and exit.
```
`./muscle result --help`
```
Usage: muscle results [OPTIONS] [JOB_ID]...

Options:
  --help  Show this message and exit.
```

## Examples:
* Run analysis on a branch: `MUSEDEV_TOKEN=MY_SECRET_JWT muscle analyze  --branch master tommd libacvp`
* Run analysis on a commit: `muscle --token MY_SECRET_JWT analyze --commit h1a2s3h tommd libacvp `
* Get analysis status `muscle --token MY_SECRET_JWT status jobID`
* Get analysis results `MUSEDEV_TOKEN=MY_SECRET_JWT muscle results jobID1 jobID2 jobID3`

## New Functionality:
* Scan all repos of an org: `./muscle scan org_name`


