Initial commit
This commit is contained in:
63
README.md
Normal file
63
README.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# redmine-reporter
|
||||
|
||||
Internal tool to generate Redmine issue reports based on your time entries.
|
||||
|
||||
## Features
|
||||
|
||||
- Secure credential handling via environment variables
|
||||
- Compact or fancy table output
|
||||
- Grouping by project and version
|
||||
- Status translation to Russian
|
||||
- CLI with intuitive arguments
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
git clone https://your-gitea/redmine-reporter.git
|
||||
cd redmine-reporter
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Create `.env` (not committed!):
|
||||
|
||||
```ini
|
||||
REDMINE_URL=https://red.eltex.loc/
|
||||
REDMINE_USER=artem.kokos
|
||||
REDMINE_PASSWORD=your_password_here
|
||||
```
|
||||
|
||||
Or export in shell:
|
||||
|
||||
```bash
|
||||
export REDMINE_URL=https://red.eltex.loc/
|
||||
export REDMINE_USER=artem.kokos
|
||||
export REDMINE_PASSWORD=...
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Default date range
|
||||
redmine-reporter
|
||||
|
||||
# Custom date range
|
||||
redmine-reporter --date 2025-12-01--2026-01-31
|
||||
|
||||
# Compact mode
|
||||
redmine-reporter --compact
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
pip install -e ".[dev]"
|
||||
pytest
|
||||
black .
|
||||
isort .
|
||||
```
|
||||
|
||||
> 🔒 Never commit `.env` or credentials!
|
||||
Reference in New Issue
Block a user