Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdelapenya/cauldrongo
A Go SDK for fetching OSS metrics from Cauldron (https://cauldron.io)
https://github.com/mdelapenya/cauldrongo
cauldron cobra golang
Last synced: about 7 hours ago
JSON representation
A Go SDK for fetching OSS metrics from Cauldron (https://cauldron.io)
- Host: GitHub
- URL: https://github.com/mdelapenya/cauldrongo
- Owner: mdelapenya
- License: mit
- Created: 2024-04-16T16:38:32.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-04-30T10:48:57.000Z (5 months ago)
- Last Synced: 2024-06-19T11:34:56.731Z (4 months ago)
- Topics: cauldron, cobra, golang
- Language: Go
- Homepage:
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cauldron Go
This is a simple Go program that fetches the OSS metrics from the Cauldron API.
## Install
- **MacOS**: You can install the CLI using the following command:
```sh
brew install mdelapenya/cauldrongo-tap/cauldrongo
```
In any other case, please download the binary from the [releases page](https://github.com/mdelapenya/cauldrongo/releases).
## Cauldron APIs
### Metrics
The metrics endpoint has the following format:
```
https://cauldron.io/project/${PROJECT_ID}/metrics?from=${FROM}&to=${TO}&tab=${TAB}
```
There is one URL parameter: `PROJECT_ID`. This is the ID of the project in Cauldron. The querystring receives four parameters:
- `from`: the start date of the metrics, in the format `YYYY-MM-DD`
- `to`: the end date of the metrics, in the format `YYYY-MM-DD`
- `tab`: the tab of the metrics
- `repo_url`: the URL of the repository. It supports multiple values, in different querystring parameters. E.g. `repo_url=foo&repo_url=bar`.
The `tab` parameter can be one of the following values:
- `overview`: the overview tab
- `activity-overview`: the activity overview tab
- `community-overview`: the community overview tab
- `performance-overview`: the performance overview tab
It's **important** to note that the repositories, and their datasources, must be refreshed before fetching the metrics. So please do it manually before querying the API.
## Usage
The CLI has one subcommand: `metrics`. It has the following flags:
- `--project-id | -p`: the project ID. Required.
- `--from | -f`: the start date of the metrics, in the format `YYYY-MM-DD`. Default is one year ago.
- `--to | -t`: the end date of the metrics, in the format `YYYY-MM-DD`. Default is today.
- `--tab | -T`: the tab of the metrics. Default is `overview`.
- `--format | -F`: the output format, can be `console` or `json`. Default is `console`.
- `--repo_url | -r`: the URL of the repository. It supports multiple values, in different parameters. E.g. `--repo_url=foo --repo_url=bar`.
There is a global flag `--config`, that can be used to specify the path to the configuration file. Its default value is `~/.cauldron-go.yaml`. If passed, and there are project-specific configurations, they will be applied ignoring the project-specific flag. The format of the file is the following:
```yaml
projects:
- id: 2296
name: testcontainers-go
repo_url:
- https://github.com/testcontainers/testcontainers-go
- https://github.com/testcontainers/testcontainers-go.git
- id: 7264
name: testcontainers-java
repo_url:
- https://github.com/testcontainers/testcontainers-java
- https://github.com/testcontainers/testcontainers-java.git
- id: 7265
name: testcontainers-dotnet
repo_url:
- https://github.com/testcontainers/testcontainers-dotnet
- https://github.com/testcontainers/testcontainers-dotnet.git
- id: 7266
name: testcontainers-node
repo_url:
- https://github.com/testcontainers/testcontainers-node
- https://github.com/testcontainers/testcontainers-node.git
- id: 7607
name: testcontainers-ruby
repo_url:
- https://github.com/testcontainers/testcontainers-ruby
- https://github.com/testcontainers/testcontainers-ruby.git
```
There is a sample configuration file in the `root` directory of the project, named `.sample-cauldrongo.yaml`.
### Examples
```sh
# Fetch the metrics for the project 1, from one year ago to today, using the overview tab, in the console format.
cauldrongo metrics --project-id 1
# Fetch the metrics for the project 1, from one year ago to today, using the performance overview tab, in the JSON format.
cauldrongo metrics --project-id 1 --tab=performance-overview --format=json
# Fetch the metrics for all the projects in the configuration file located in the ${MY_CAULDRON_FILE} path, from one year ago to today, using the performance overview tab, in the JSON format.
cauldrongo metrics --config=${MY_CAULDRON_FILE} --project-id 1 --tab=performance-overview --format=json
# Fetch the metrics for the project 1, from one year ago to today, using the performance overview tab, in the JSON format, for the repositories foo and bar.
cauldrongo metrics --config=${MY_CAULDRON_FILE} --project-id 1 --tab=performance-overview --format=json --repo_url=foo --repo_url=bar
```
## Not implemented (yet)
- Refresh the repositories and datasources before fetching the metrics, using the refresh endpoint, but we need to deal with credentials, so I'm postponing it for a second iteration.