Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onlydole/devstats-cli
📈 Query contribution statistics from CNCF's DevStats
https://github.com/onlydole/devstats-cli
cloudnative devstats rust
Last synced: 8 days ago
JSON representation
📈 Query contribution statistics from CNCF's DevStats
- Host: GitHub
- URL: https://github.com/onlydole/devstats-cli
- Owner: onlydole
- License: apache-2.0
- Created: 2024-08-14T00:32:27.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-11T16:09:26.000Z (about 1 month ago)
- Last Synced: 2024-12-09T10:52:25.387Z (13 days ago)
- Topics: cloudnative, devstats, rust
- Language: Rust
- Homepage: https://devstats.cncf.io
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DevStats CLI
DevStats CLI is a command-line interface tool for querying contribution statistics from the CNCF's DevStats. It allows users to easily retrieve and view contribution data for specific projects, time ranges, and metrics.
## Features
- Query DevStats API for contribution data
- Customize queries by project, time range, and metric
- Display results in a user-friendly, colored output
- Verbose logging option for troubleshooting
## Installation
### Prerequisites
- Rust programming language (latest stable version)
- Cargo package manager
### Steps
1. Clone the repository:
```sh
git clone https://github.com/yourusername/devstats-cli.git
cd devstats-cli
```
2. Build the project:
```sh
cargo build --release
```
3. The binary will be available in `target/release/devstats-cli`
## Usage
Basic usage:
```sh
devstats-cli -u
```
Full usage with all options:
```sh
devstats-cli -u -p -r -m [-v]
```
Options:
- `-u, --username `: GitHub username to query (required)
- `-p, --project `: Project to query (default: "All CNCF")
- `-r, --range `: Time range for the query (default: "Last quarter")
- `-m, --metric `: Metric to query (default: "Contributions")
- `-v, --verbose`: Enable verbose logging
Example:
```sh
devstats-cli -u onlydole -p Kubernetes -r "Last year" -m "Commits"
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [CNCF DevStats platform](https://devstats.cncf.io) for providing the [API](https://github.com/cncf/devstatscode#api)