Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kartben/zephyr-repo-metrics
https://github.com/kartben/zephyr-repo-metrics
dashboard metrics statistics zephyr zephyr-rtos
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/kartben/zephyr-repo-metrics
- Owner: kartben
- License: mit
- Created: 2014-10-16T22:11:20.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:57:04.000Z (18 days ago)
- Last Synced: 2024-10-29T15:23:37.754Z (18 days ago)
- Topics: dashboard, metrics, statistics, zephyr, zephyr-rtos
- Language: TypeScript
- Homepage: http://kartben.github.io/zephyr-repo-metrics/
- Size: 2.94 MB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zephyr Repo Metrics
This repository contains a script that can be used (and extended) to gather stats regarding the activity of some popular open source real-time operating systems.
The main script is written in TypeScript and can be executed using `npm start`.
## Features
* Automatically clones or updates the specified RTOS repositories
* Computes and saves statistics for each repository in JSON and CSV formats
* Generates an aggregated CSV file containing data for all projects
* Uses a progress bar to display the current status of the script
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/kartben/zephyr-repo-metrics.git
cd zephyr-repo-metrics
```
2. Install the required dependencies:
```bash
npm install
```
3. Run the script:
```bash
npm start
```
## How It Works
The script will automatically clone or update the specified repositories and compute the statistics. The results will be saved in the `stats/` directory as separate JSON and CSV files for each project. An aggregated CSV file, `all.csv`, containing data for all projects, will also be generated.
## Customization
You can customize the script by modifying the projects and snippets in the `projects.ts` and `snippets.ts` files. Add or modify the projects and snippets as needed to gather the desired statistics for your projects.
## Ready to use dashboards and charts
The `dashboard-files/` folder contains a Microsoft Excel spreadsheet ([`dashboard.xlsx`](/dashboard-files/dashboard.xlsx)) which you can use to directly access pivot tables and charts that make the data more visual. If you allow Excel to load external content, it will automatically sync-up the data with the latest version of the [`all.csv`](https://github.com/kartben/zephyr-repo-metrics/blob/statistics/stats/all.csv) file that lives in the `statistics` branch of this repository.
Similarly, you may want to play with the Microsoft PowerBI [`dashboard.pbix`](/dashboard-files/dashboard.pbix).
## Contributing
If you find any bugs, have feature requests, or would like to contribute, feel free to open an issue or submit a pull request on the repository.
## License
This project is licensed under the MIT License. See the [LICENSE](/LICENSE) file for more information.