56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# README for Bug Chart
|
|
|
|
## Overview
|
|
Bug Chart is a Python tool designed to visualize the number of open bugs over time in a Forgejo repository. It retrieves data from Forgejo's API and generates a line graph showing the trend of open bugs. This tool is particularly useful for project managers and developers who want to track bug trends in their software projects.
|
|
|
|
## Features
|
|
- **Data Retrieval**: Downloads bug data from Forgejo using API tokens.
|
|
- **Graph Generation**: Creates an HTML file with a line graph representing open bugs over time.
|
|
- **Caching**: Stores bug data locally to reduce API calls.
|
|
- **Refresh Capability**: Can be manually refreshed to update the data and graph.
|
|
|
|
## Requirements
|
|
- Python 3
|
|
- Libraries: `requests`, `json`, `configparser`
|
|
|
|
## Installation
|
|
Clone the repository from [https://git.4angle.com/edward/bug-chart](https://git.4angle.com/edward/bug-chart). Ensure you have Python 3 and the required libraries installed.
|
|
|
|
## Configuration
|
|
Create a configuration file with the following structure:
|
|
|
|
```ini
|
|
[forgejo]
|
|
hostname=<Your Forgejo hostname>
|
|
token=<Your Forgejo Token>
|
|
|
|
[output]
|
|
dest=<Path to output HTML file>
|
|
cache=<Path to cache JSON file>
|
|
```
|
|
|
|
## Usage
|
|
Run `build.py` to generate the bug chart. The script can be scheduled to run periodically using cron. For example:
|
|
|
|
```bash
|
|
40 9 * * * python3 ~/src/bug-chart/backup.py --refresh
|
|
```
|
|
|
|
To force a data refresh, run:
|
|
|
|
```bash
|
|
python3 build.py --refresh
|
|
```
|
|
|
|
## Output
|
|
The script generates an HTML file (`chart.html`) displaying the line graph of open bugs over time.
|
|
|
|
## License
|
|
This project is licensed under the MIT License.
|
|
|
|
## Contact
|
|
For queries or contributions, please email Edward Betts at [edward@4angle.com](mailto:edward@4angle.com).
|
|
|
|
## Acknowledgements
|
|
Developed and maintained by Edward Betts.
|