<commit_before>## Synopsis

Python3 script to generate daily status reports for JIRA projects using JIRA REST API.

## Motivation

All our software projects are using Atlassian JIRA platform for their project management and development tracking efforts.
Project Managers of those projects needed a simple solution where they can get daily status report about any work or activities being done by team members on their respective JIRA projects.

The information they required in these daily status report of JIRA projects were followings:
- Each team member, working on a JIRA project should receive their daily status report over email which will contain details about any worklogs or activities (issue commit/resolve/fixed/comment) being performed by them on JIRA issues of that project.
- These individual team member reports should also be emailed to project Manager's email address of that JIRA project.
- If there are no user worklogs or activities done on JIRA issues of that project on any particular day then a no worklog report should be emailed only to that Project manager's email address.

The reason I open sourced this home grown solution, thinking may be someone out there might have similar requirement to get a daily status reports about work and activities being performed on any JIRA projects and can make use of this small implementaion.

## Requirements

- Python3
- for additional pip modules used by script check [requirements.txt](requirements.txt)
- REST API is enabled on JIRA servers where JIRA projects are present.

## Installation

Download this script into a directory from where it should be run by simply copying it.

```user@~$ git clone https://github.com/AshishKumar-AK/JIRA-DSR-REPORT.git```

OR by running in a separate virtualenv

```
user@~$ pip3 install virtualenv
user@~$ cd my_project_folder
user@my_project_folder$ virtualenv venv
user@my_project_folder$ git clone https://github.com/AshishKumar-AK/JIRA-DSR-REPORT.git
user@my_project_folder$ source venv/bin/activate
user@my_project_folder(venv)$ pip3 install -r requirements.txt
```

Check if now script can be run successfully

```user@my_project_folder(venv)$ python3 JIRA_DSR.py --help```

## Script Setup

Before understanding inner details of script functionality and its working, we should first understand about script components and its configuration setup.

- [JIRA_DSR.py](JIRA_DSR.py): This is main python3 script which generates JIRA DSR reports.
- [conf](conf): The "conf" directory contains following items which are required for script execution:
<commit_msg>updated correct github repo url in installation section of README<commit_after>## Synopsis

Python3 script to generate daily status reports for JIRA projects using JIRA REST API.

## Motivation

All our software projects are using Atlassian JIRA platform for their project management and development tracking efforts.
Project Managers of those projects needed a simple solution where they can get daily status report about any work or activities being done by team members on their respective JIRA projects.

The information they required in these daily status report of JIRA projects were followings:
- Each team member, working on a JIRA project should receive their daily status report over email which will contain details about any worklogs or activities (issue commit/resolve/fixed/comment) being performed by them on JIRA issues of that project.
- These individual team member reports should also be emailed to project Manager's email address of that JIRA project.
- If there are no user worklogs or activities done on JIRA issues of that project on any particular day then a no worklog report should be emailed only to that Project manager's email address.

The reason I open sourced this home grown solution, thinking may be someone out there might have similar requirement to get a daily status reports about work and activities being performed on any JIRA projects and can make use of this small implementaion.

## Requirements

- Python3
- for additional pip modules used by script check [requirements.txt](requirements.txt)
- REST API is enabled on JIRA servers where JIRA projects are present.

## Installation

Download this script into a directory from where it should be run by simply copying it.

```user@~$ git clone https://github.com/AshishKumar-AK/JIRA-DSR.git```

OR by running in a separate virtualenv

```
user@~$ pip3 install virtualenv
user@~$ cd my_project_folder
user@my_project_folder$ virtualenv -p $(which python3) venv
user@my_project_folder$ git clone https://github.com/AshishKumar-AK/JIRA-DSR.git
user@my_project_folder$ source venv/bin/activate
user@my_project_folder(venv)$ pip3 install -r requirements.txt
```

Check if now script can be run successfully

```user@my_project_folder(venv)$ python3 JIRA_DSR.py --help```

## Script Setup

Before understanding inner details of script functionality and its working, we should first understand about script components and its configuration setup.

- [JIRA_DSR.py](JIRA_DSR.py): This is main python3 script which generates JIRA DSR reports.
- [conf](conf): The "conf" directory contains following items which are required for script execution:

{'fraction_non_alphanumeric': 0.05117352828010773, 'fraction_numerical': 0.002500961908426318, 'mean_word_length': 5.031322505800464, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1929445', 'n_tokens_mistral': 1337, 'n_tokens_neox': 1299, 'n_words': 698}